{"openapi":"3.1.0","info":{"title":"DutchDataroom API","version":"0.0.0","description":"Contract-first API (ADR-0001)."},"servers":[{"url":"/"}],"components":{"schemas":{},"parameters":{}},"paths":{"/api/v1/t/{tenantId}/dossier-packs":{"get":{"operationId":"listDossierPacks","summary":"List the available dossier packs of the firm","description":"The public, available-only dossier-pack catalogue: id, version, sector profile, NL/EN label and description, compatible legacy room type, module/template counts and honest availability notes (SECTOR-PLATFORM-PLAN §4/§12). Draft and retired packs and tenant-foreign overrides are never returned. A pack is platform data; listing it grants no access. Pack selection/permission policy stays authoritative. No audit event.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"anyOf":[{"type":"string","enum":["legal","mortgage","notary","accountancy","financial_planning","mediation","insolvency","real_estate","mergers_acquisitions","fundraising","public_sector","corporate","healthcare_life_sciences"],"description":"Profession profile of the firm (ADR-0058): seven legacy profiles plus six additive sector profiles. A profile only groups packs and wording; it never grants access."},{"type":"string","enum":["general"]}],"description":"Pack grouping: a profession profile id or the neutral general grouping (never a vertical)."},"required":false,"description":"Pack grouping: a profession profile id or the neutral general grouping (never a vertical).","name":"sectorProfileId","in":"query"},{"schema":{"type":"string","enum":["client_portal","litigation","mortgage_advice"],"description":"Room type the firm allows."},"required":false,"description":"Room type the firm allows.","name":"compatibleRoomType","in":"query"}],"responses":{"200":{"description":"Available packs the caller may use, stable order.","content":{"application/json":{"schema":{"type":"object","properties":{"packs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable pack id (lower snake case, never a label)."},"version":{"type":"integer","minimum":1,"maximum":1000000,"description":"Pack version (immutable once released)."},"sectorProfileId":{"anyOf":[{"type":"string","enum":["legal","mortgage","notary","accountancy","financial_planning","mediation","insolvency","real_estate","mergers_acquisitions","fundraising","public_sector","corporate","healthcare_life_sciences"],"description":"Profession profile of the firm (ADR-0058): seven legacy profiles plus six additive sector profiles. A profile only groups packs and wording; it never grants access."},{"type":"string","enum":["general"]}],"description":"Pack grouping: a profession profile id or the neutral general grouping (never a vertical)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"description":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"compatibleRoomType":{"type":"string","enum":["client_portal","litigation","mortgage_advice"],"description":"Room type the firm allows."},"moduleCount":{"type":"integer","minimum":0},"templateCount":{"type":"integer","minimum":0},"availabilityNotes":{"type":"array","items":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}}},"required":["id","version","sectorProfileId","label","description","compatibleRoomType","moduleCount","templateCount","availabilityNotes"],"description":"Public, available-only summary of one dossier pack."},"description":"Available packs the caller may use, stable order."},"officeRevision":{"type":"integer","minimum":0},"defaultPackId":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable pack id (lower snake case, never a label)."}},"required":["packs","officeRevision","defaultPackId"]}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Not a firm user; guests and support.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/medical-disclosures":{"post":{"operationId":"logDisclosure","summary":"Log one targeted medical disclosure","description":"`room.medical_disclosure.log` (`manage` on the room, firm users, step-up). Names the medical document, the injured party (subject), the recipient and the purpose, and logs what went to whom and when. The node must sit under a marked \"Medisch\" zone (409 `DISCLOSURE_NOT_MEDICAL` otherwise). Writes `medical_disclosure.logged` (ids and codes only).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid","description":"The disclosed medical document."},"nodeId":{"type":"string","format":"uuid","description":"The index node of the disclosed medical document."},"versionNo":{"type":"integer","minimum":0,"description":"Disclosed version; 0 when the disclosure is not version-specific."},"subjectPrincipalId":{"type":"string","format":"uuid","description":"The injured party whose medical data is disclosed."},"subjectKind":{"type":"string","enum":["user","guest"],"description":"Principal kind of the injured party."},"recipientPrincipalId":{"type":"string","nullable":true,"format":"uuid","description":"The receiving principal; null for an external recipient."},"recipientKind":{"type":"string","enum":["user","guest","external"],"description":"A principal inside the room, or an external party outside of it."},"recipientCode":{"type":"string","nullable":true,"enum":["medical_expert","insurer","court","opposing_counsel","supervisor",null],"description":"The external recipient class; null when the recipient is a principal."},"purpose":{"type":"string","enum":["treatment","expert_review","insurer_claim","court_filing","second_opinion"],"description":"Why the medical information is disclosed."},"evidenceDocumentId":{"type":"string","nullable":true,"format":"uuid","description":"Supporting authority/basis document in the same room (ids only, never content). Null or absent when the basis is recorded as a short reference instead."},"evidenceReference":{"type":"string","nullable":true,"minLength":1,"maxLength":200,"description":"Short reference for the supporting authority (mandate or file reference, ids/codes only)."},"validUntil":{"type":"string","nullable":true,"format":"date-time","description":"End of the validity of this disclosure binding; null or absent means no expiry was set."}},"required":["documentId","nodeId","versionNo","subjectPrincipalId","subjectKind","recipientPrincipalId","recipientKind","recipientCode","purpose"],"additionalProperties":false,"description":"Log one targeted medical disclosure (`room.medical_disclosure.log`, firm users)."}}}},"responses":{"201":{"description":"The logged disclosure.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"tenantId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"nodeId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":0},"subjectPrincipalId":{"type":"string","format":"uuid"},"subjectKind":{"type":"string","enum":["user","guest"]},"recipientPrincipalId":{"type":"string","nullable":true,"format":"uuid"},"recipientKind":{"type":"string","enum":["user","guest","external"],"description":"A principal inside the room, or an external party outside of it."},"recipientCode":{"type":"string","nullable":true,"enum":["medical_expert","insurer","court","opposing_counsel","supervisor",null],"description":"The external recipient class, when the recipient is not a principal."},"purpose":{"type":"string","enum":["treatment","expert_review","insurer_claim","court_filing","second_opinion"],"description":"Why the medical information is disclosed."},"evidenceDocumentId":{"type":"string","nullable":true,"format":"uuid","description":"Supporting authority/basis document in the same room (ids only, never content)."},"evidenceReference":{"type":"string","nullable":true,"description":"Short reference for the supporting authority (mandate or file reference, ids/codes only)."},"validUntil":{"type":"string","nullable":true,"format":"date-time","description":"End of the validity of this disclosure binding; null means no expiry was set."},"revokedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the binding was withdrawn; null while the binding stands. Rows are never deleted."},"revokedBy":{"type":"string","nullable":true,"format":"uuid","description":"The firm user who withdrew the binding; null while it stands."},"revokeReason":{"type":"string","nullable":true,"description":"Why the binding was withdrawn (stored with the row, never in the audit trail)."},"status":{"type":"string","enum":["active","expired","revoked"],"description":"Standing of the binding, computed when the row is read."},"authorizedBy":{"type":"string","format":"uuid","description":"The firm user who authorized the disclosure."},"authorizedAt":{"type":"string","format":"date-time"},"disclosedAt":{"type":"string","format":"date-time"}},"required":["id","tenantId","roomId","documentId","nodeId","versionNo","subjectPrincipalId","subjectKind","recipientPrincipalId","recipientKind","recipientCode","purpose","evidenceDocumentId","evidenceReference","validUntil","revokedAt","revokedBy","revokeReason","status","authorizedBy","authorizedAt","disclosedAt"],"description":"One targeted medical disclosure: what went to whom, when, for which purpose."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"`STEP_UP_REQUIRED`: fresh authentication is required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Visible, but the caller lacks the level or role.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, node, group or client; no access; cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"`DISCLOSURE_NOT_MEDICAL`: the document is not inside a marked zone.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"get":{"operationId":"listDisclosures","summary":"Read the targeted disclosures of one injured party (subject's own log)","description":"`room.medical_disclosure.read` (any room member; guests read only themselves, a foreign subject is a no-hint 404). Oldest first; each row carries its supporting reference, validity and computed standing; ids and codes only, never client data.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"The injured party whose disclosures are read; guests read only themselves."},"required":true,"description":"The injured party whose disclosures are read; guests read only themselves.","name":"subject","in":"query"}],"responses":{"200":{"description":"The subject's disclosures, oldest first.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"tenantId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"nodeId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":0},"subjectPrincipalId":{"type":"string","format":"uuid"},"subjectKind":{"type":"string","enum":["user","guest"]},"recipientPrincipalId":{"type":"string","nullable":true,"format":"uuid"},"recipientKind":{"type":"string","enum":["user","guest","external"],"description":"A principal inside the room, or an external party outside of it."},"recipientCode":{"type":"string","nullable":true,"enum":["medical_expert","insurer","court","opposing_counsel","supervisor",null],"description":"The external recipient class, when the recipient is not a principal."},"purpose":{"type":"string","enum":["treatment","expert_review","insurer_claim","court_filing","second_opinion"],"description":"Why the medical information is disclosed."},"evidenceDocumentId":{"type":"string","nullable":true,"format":"uuid","description":"Supporting authority/basis document in the same room (ids only, never content)."},"evidenceReference":{"type":"string","nullable":true,"description":"Short reference for the supporting authority (mandate or file reference, ids/codes only)."},"validUntil":{"type":"string","nullable":true,"format":"date-time","description":"End of the validity of this disclosure binding; null means no expiry was set."},"revokedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the binding was withdrawn; null while the binding stands. Rows are never deleted."},"revokedBy":{"type":"string","nullable":true,"format":"uuid","description":"The firm user who withdrew the binding; null while it stands."},"revokeReason":{"type":"string","nullable":true,"description":"Why the binding was withdrawn (stored with the row, never in the audit trail)."},"status":{"type":"string","enum":["active","expired","revoked"],"description":"Standing of the binding, computed when the row is read."},"authorizedBy":{"type":"string","format":"uuid","description":"The firm user who authorized the disclosure."},"authorizedAt":{"type":"string","format":"date-time"},"disclosedAt":{"type":"string","format":"date-time"}},"required":["id","tenantId","roomId","documentId","nodeId","versionNo","subjectPrincipalId","subjectKind","recipientPrincipalId","recipientKind","recipientCode","purpose","evidenceDocumentId","evidenceReference","validUntil","revokedAt","revokedBy","revokeReason","status","authorizedBy","authorizedAt","disclosedAt"],"description":"One targeted medical disclosure: what went to whom, when, for which purpose."}}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Visible, but the caller lacks the level or role.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, node, group or client; no access; cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/me":{"get":{"operationId":"getMe","summary":"Identity-level session summary","description":"Returns 200 with the session cookie, 401 without one (ADR-0003 D3, web contract).","responses":{"200":{"description":"Signed in.","content":{"application/json":{"schema":{"type":"object","properties":{"subject":{"type":"object","properties":{"kind":{"type":"string","enum":["keycloak","guest_email","platform"],"description":"ADR-0003 D3: who signed in."},"id":{"type":"string","description":"Keycloak sub or guest identity id (opaque to the web)."}},"required":["kind","id"]},"principals":{"type":"array","items":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid","description":"Tenant that owns the principal."},"principalId":{"type":"string","format":"uuid","description":"Principal bound to the session subject in that tenant."},"kind":{"type":"string","enum":["user","guest","support"],"description":"Principal kind of one tenant binding."},"status":{"type":"string","enum":["active","blocked","deactivated"],"description":"Principal status."},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Firm vertical of that tenant (ADR-0030); user bindings only."},"roles":{"type":"array","items":{"type":"string","enum":["firm_admin","lawyer","legal_assistant","secretary","billing","adviser","back_office","compliance"],"description":"Firm role (ADR-0005 §3)."},"description":"Active firm roles in that tenant; user bindings only. Lets the web hide firm admin navigation; the API still authorizes every request."},"capabilities":{"type":"array","items":{"type":"string","enum":["wwft_cdd","mortgage_files","litigation_exports","bsn_guardrail","medical_zones","deal_room","legal_practice"],"description":"Switchable office function (SP08): wwft_cdd (Wwft client research), mortgage_files (mortgage deadlines, checklist, Kifid export and the /mortgage overview), litigation_exports (productions, Mijn Rechtspraak bundle), bsn_guardrail (BSN upload guardrail), medical_zones (injury-case zones) or deal_room (Q&A, bidder groups, phased release) or legal_practice (lawyer wording, practice area and counterparty fields and the legal help articles; presentation only, the API keeps accepting the fields so no data is lost). Security, MFA, audit, retention floors, legal holds, rights and step-up are never capabilities."},"maxItems":7,"description":"Enabled switchable office functions of that tenant (SP08, T-261012-9c32); user bindings only. Lets the web hide switched-off sector screens; the API still authorizes every request."},"vocabulary":{"type":"string","enum":["legal","transaction","finance","neutral"],"description":"Sector-derived office wording; presentation only, user bindings only."},"integrations":{"type":"object","properties":{"memberApiKeys":{"type":"boolean","description":"Members may create their own keys in this tenant."},"memberMcp":{"type":"boolean","description":"A personal key may use the MCP endpoint."},"maxDays":{"type":"integer","minimum":1,"maximum":365,"description":"Lifetime ceiling in days."},"maxKeys":{"type":"integer","minimum":1,"maximum":20,"description":"Active personal keys per member."},"scopes":{"type":"array","items":{"type":"string","enum":["rooms.read","documents.read","documents.upload","flows.read","exhibits.read","messaging.read","qa.read","team.read","office.read"],"description":"One scope a personal key may hold (ADR-0067 D4: read-only plus documents.upload)."},"description":"Scopes the firm allows on a personal key."},"roomScopeRequired":{"type":"boolean","description":"A personal key must name its data rooms."}},"required":["memberApiKeys","memberMcp","maxDays","maxKeys","scopes","roomScopeRequired"],"description":"Personal integration settings of that tenant (ADR-0067 D4); user bindings only. Lets the web hide Mijn koppelingen; the API still refuses every personal-key request while the switch is off."}},"required":["tenantId","principalId","kind","status"],"description":"One tenant binding of the session subject."},"description":"Active tenant bindings of the subject."},"locale":{"type":"string","enum":["nl","en"],"description":"Profile language of the signed-in identity."}},"required":["subject","principals"],"description":"Identity-level session summary."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/auth/login":{"get":{"operationId":"startLogin","summary":"Start the OIDC code flow","description":"Sets __Host-ddr_pre and redirects to Keycloak (ADR-0003 D4).","parameters":[{"schema":{"type":"string","maxLength":2048,"description":"Relative path to return to after sign-in."},"required":false,"description":"Relative path to return to after sign-in.","name":"returnTo","in":"query"}],"responses":{"302":{"description":"Redirect to Keycloak."},"400":{"description":"Invalid request.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/auth/callback":{"get":{"operationId":"oidcCallback","summary":"OIDC callback","description":"Validates state/code, creates the session and redirects to returnTo (ADR-0003 D4, D12). A callback whose challenge is a step-up re-authenticates the existing session: the subject must match, the strength requirement must hold, and the session secret is rotated (ADR-0003 D5).","parameters":[{"schema":{"type":"string"},"required":false,"name":"code","in":"query"},{"schema":{"type":"string"},"required":false,"name":"state","in":"query"},{"schema":{"type":"string"},"required":false,"name":"error","in":"query"},{"schema":{"type":"string"},"required":false,"name":"error_description","in":"query"}],"responses":{"302":{"description":"Redirect to returnTo or the sign-in page."},"401":{"description":"Sign-in failed (no session, no auto-redirect).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]},"notice":{"type":"object","properties":{"titleKey":{"type":"string","enum":["auth.signInAgain.title"]},"bodyKey":{"type":"string","enum":["auth.signInAgain.body"]},"actionKey":{"type":"string","enum":["auth.signInAgain.action"]}},"required":["titleKey","bodyKey","actionKey"],"description":"Notice keys for the sign-in-again page."}},"required":["error","notice"],"description":"Sign-in failure with the notice keys the client renders."}}}}}}},"/api/v1/auth/logout":{"post":{"operationId":"logout","summary":"Sign out","description":"Revokes the session and clears the cookie (ADR-0003 D4).","responses":{"204":{"description":"Signed out."},"401":{"description":"No session.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/auth/sessions":{"get":{"operationId":"listSessions","summary":"List my sessions and devices","description":"The signed-in identity's own sessions with device, country, last seen and current flag (SEC-07, S-AUTH-04/S-FIRM-09, ADR-0003 D3). Any session, own data only: a firm never sees guest sessions and a guest sees only its own. No IP address is ever returned.","responses":{"200":{"description":"My sessions.","content":{"application/json":{"schema":{"type":"object","properties":{"sessions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"`auth_session.id` (opaque to the UI)."},"device":{"type":"string","minLength":1,"maxLength":200,"description":"Normalised device label `<browser>-<major>/<os>` (ADR-0006)."},"country":{"type":"string","nullable":true,"minLength":2,"maxLength":2,"description":"ISO 3166-1 alpha-2 country from the local, offline GeoIP database; null when none is configured. Never an IP address."},"principalKind":{"type":"string","enum":["user","guest","support"],"description":"Principal kind of one tenant binding."},"authStrength":{"type":"string","enum":["single","mfa"],"description":"single = password or guest code only; mfa = a second factor holds for this session."},"current":{"type":"boolean","description":"True for the session that makes this request (\"this device\")."},"createdAt":{"type":"string","format":"date-time","description":"First sign-in of the session."},"lastSeenAt":{"type":"string","format":"date-time","description":"Last request that passed the guard (written at most once per 60 s)."},"idleExpiresAt":{"type":"string","format":"date-time","description":"When the idle timeout would end this session; feeds the S-AUTH-08 warning."},"absoluteExpiresAt":{"type":"string","format":"date-time","description":"When the absolute lifetime ends the session."}},"required":["id","device","country","principalKind","authStrength","current","createdAt","lastSeenAt","idleExpiresAt","absoluteExpiresAt"],"description":"One of the caller's own sessions, newest activity first."},"description":"The caller's own sessions, current session first, then newest activity first."}},"required":["sessions"],"description":"Sessions and devices of the signed-in identity (SEC-07, ADR-0003 D3)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (code NOT_FOUND). The route is registered by T-260914-c85a; until then an unmatched request answers the framework 404.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/auth/sessions/{sessionId}":{"delete":{"operationId":"revokeSession","summary":"Sign out one of my sessions","description":"Revokes one of the caller's own sessions; it stops working on the next request (SEC-07, PERM-10, ADR-0003 D3). An unknown, foreign or already revoked session id answers 404 without revealing existence (PERM-02). Writes `session.revoked` with revoked_scope `session`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Session id (`auth_session.id`)."},"required":true,"description":"Session id (`auth_session.id`).","name":"sessionId","in":"path"}],"responses":{"204":{"description":"The session is revoked."},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"No such own session.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/auth/sessions/revoke-all":{"post":{"operationId":"revokeAllSessions","summary":"Sign out my other devices (or everywhere)","description":"Revokes the caller's own sessions, optionally including the current one (SEC-07, PERM-10, ADR-0003 D3). The default revokes every other device, matching S-FIRM-09 \"Sign out on all other devices\". Writes `session.revoked` with revoked_scope `all`.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"includeCurrent":{"type":"boolean","default":false,"description":"false = sign out on all other devices; true = sign out everywhere."}},"description":"Which of the caller's own sessions to revoke."}}}},"responses":{"200":{"description":"How many sessions were revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"revokedSessionCount":{"type":"integer","minimum":0,"description":"How many sessions were revoked."}},"required":["revokedSessionCount"],"description":"Result of a bulk session revocation."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (code NOT_FOUND). The route is registered by T-260914-c85a; until then an unmatched request answers the framework 404.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/firm/members/{principalId}/sessions":{"get":{"operationId":"listFirmMemberSessions","summary":"List a firm member's active sessions","description":"Firm admins and compliance through user.read (ADR-0005 §3, S-ADMIN-11). Reads this tenant's `auth_session_tenant` rows joined to the device and country of the session: device, country and first/last seen only, never an IP and nothing outside the tenant. Guests are never firm members, so a guest principal answers 404 like an unknown or cross-tenant one (PERM-02).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the member."},"required":true,"description":"Tenant that owns the member.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Member principal id."},"required":true,"description":"Member principal id.","name":"principalId","in":"path"}],"responses":{"200":{"description":"Active sessions of the member.","content":{"application/json":{"schema":{"type":"object","properties":{"sessions":{"type":"array","items":{"type":"object","properties":{"sessionId":{"type":"string","format":"uuid","description":"`auth_session.id`; the same id the member sees in their own list."},"device":{"type":"string","minLength":1,"maxLength":200,"description":"Normalised device label (ADR-0006)."},"country":{"type":"string","nullable":true,"minLength":2,"maxLength":2,"description":"ISO 3166-1 alpha-2 country; null when unknown. Never an IP address."},"firstSeenAt":{"type":"string","format":"date-time","description":"First request of this session in this tenant."},"lastSeenAt":{"type":"string","format":"date-time","description":"Last request of this session in this tenant."},"current":{"type":"boolean","description":"True only when this is the caller's own current session (viewing themselves)."}},"required":["sessionId","device","country","firstSeenAt","lastSeenAt","current"],"description":"One active session of a firm member inside this tenant."}}},"required":["sessions"],"description":"Active sessions of one firm member in this tenant."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Not a firm admin or compliance.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown, cross-tenant or non-user principal.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"delete":{"operationId":"revokeFirmMemberSessions","summary":"Sign out a firm member everywhere in this tenant","description":"Firm admins only (ADR-0005 §3). Revokes this tenant's session rows for the member; the member is signed out on the next request (PERM-10, ADR-0003 D3a). A shared identity keeps working in its other tenants and the principal is not blocked (blocking is `principal.block`, T-260914-b555). Writes `session.revoked` with revoked_scope `all`. Guests answer 404 (PERM-02).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the member."},"required":true,"description":"Tenant that owns the member.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Member principal id."},"required":true,"description":"Member principal id.","name":"principalId","in":"path"}],"responses":{"200":{"description":"How many sessions were revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"revokedSessionCount":{"type":"integer","minimum":0,"description":"How many sessions were revoked."}},"required":["revokedSessionCount"],"description":"Result of a bulk session revocation."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Not a firm admin.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown, cross-tenant or non-user principal.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/me/ui-preferences":{"get":{"operationId":"getUiPreferences","summary":"Read my global UI preferences","description":"Per-principal density, sidebar, shortcuts and detail panel settings (T-260914-1863, UX-08/UX-09/UX-11). Identity-level: any session, own data only, 404 on tenant mismatch. Not audited.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"My preferences.","content":{"application/json":{"schema":{"type":"object","properties":{"density":{"type":"string","enum":["comfortable","compact"],"description":"Row density (default comfortable)."},"sidebarPinned":{"type":"boolean","description":"Pin the firm sidebar open at >= lg (UX-L05)."},"shortcutsEnabled":{"type":"boolean","description":"Single-character shortcuts on/off (UX-L34)."},"detailPanelOpen":{"type":"boolean","description":"Detail panel open by default (UX-L19)."},"detailPanelWidth":{"type":"integer","minimum":320,"maximum":560,"description":"Docked detail panel width in px, 320-560 (UX-L19)."}},"required":["density","sidebarPinned","shortcutsEnabled","detailPanelOpen","detailPanelWidth"],"additionalProperties":false,"description":"Global UI preferences of the calling principal."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"put":{"operationId":"putUiPreferences","summary":"Replace my global UI preferences","description":"Strict validation: closed enums, ranges (panel 320-560), unknown keys rejected. Not audited.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"Stored preferences.","content":{"application/json":{"schema":{"type":"object","properties":{"density":{"type":"string","enum":["comfortable","compact"],"description":"Row density (default comfortable)."},"sidebarPinned":{"type":"boolean","description":"Pin the firm sidebar open at >= lg (UX-L05)."},"shortcutsEnabled":{"type":"boolean","description":"Single-character shortcuts on/off (UX-L34)."},"detailPanelOpen":{"type":"boolean","description":"Detail panel open by default (UX-L19)."},"detailPanelWidth":{"type":"integer","minimum":320,"maximum":560,"description":"Docked detail panel width in px, 320-560 (UX-L19)."}},"required":["density","sidebarPinned","shortcutsEnabled","detailPanelOpen","detailPanelWidth"],"additionalProperties":false,"description":"Global UI preferences of the calling principal."}}}},"400":{"description":"Invalid request.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/me/rooms/{roomId}/ui-preferences":{"get":{"operationId":"getRoomUiPreferences","summary":"Read my UI preferences for one room","description":"Per-principal layout, tree and column settings (UX-L02, UX-L03, UX-L08, UX-L12). Requires room access (room.read); 404 without access. Not audited.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"My room preferences.","content":{"application/json":{"schema":{"type":"object","properties":{"layout":{"type":"string","nullable":true,"enum":["structured","simple",null],"description":"Manual layout choice, null for automatic (UX-L03)."},"lastLayout":{"type":"string","nullable":true,"enum":["structured","simple",null],"description":"Last applied layout for the UX-L02 hysteresis."},"treeWidth":{"type":"integer","minimum":240,"maximum":500,"description":"Tree pane width in px, 240-500 (UX-L08, DRE-4: 200px cut off long folder names)."},"treeCollapsed":{"type":"boolean","description":"Tree pane collapsed (UX-L08)."},"visibleColumns":{"type":"array","items":{"type":"string","enum":["modified","uploadedBy","tags","size","version","documentDate","language","privileged","access"],"description":"Optional table column ID."},"maxItems":9,"description":"Optional visible columns by ID (UX-L12)."},"reviewNoticeDismissed":{"type":"boolean","description":"The upload review notice over the room index was dismissed; absent means shown."}},"required":["layout","lastLayout","treeWidth","treeCollapsed","visibleColumns"],"additionalProperties":false,"description":"Room UI preferences of the calling principal for one room."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, or no access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"put":{"operationId":"putRoomUiPreferences","summary":"Replace my UI preferences for one room","description":"Strict validation: closed enums, ranges (tree 200-480), unknown keys rejected. Declares room.read (preferences are not content mutations). Not audited.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"Stored room preferences.","content":{"application/json":{"schema":{"type":"object","properties":{"layout":{"type":"string","nullable":true,"enum":["structured","simple",null],"description":"Manual layout choice, null for automatic (UX-L03)."},"lastLayout":{"type":"string","nullable":true,"enum":["structured","simple",null],"description":"Last applied layout for the UX-L02 hysteresis."},"treeWidth":{"type":"integer","minimum":240,"maximum":500,"description":"Tree pane width in px, 240-500 (UX-L08, DRE-4: 200px cut off long folder names)."},"treeCollapsed":{"type":"boolean","description":"Tree pane collapsed (UX-L08)."},"visibleColumns":{"type":"array","items":{"type":"string","enum":["modified","uploadedBy","tags","size","version","documentDate","language","privileged","access"],"description":"Optional table column ID."},"maxItems":9,"description":"Optional visible columns by ID (UX-L12)."},"reviewNoticeDismissed":{"type":"boolean","description":"The upload review notice over the room index was dismissed; absent means shown."}},"required":["layout","lastLayout","treeWidth","treeCollapsed","visibleColumns"],"additionalProperties":false,"description":"Room UI preferences of the calling principal for one room."}}}},"400":{"description":"Invalid request.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, or no access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/healthz":{"get":{"operationId":"getHealth","summary":"Liveness","responses":{"200":{"description":"Alive.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"],"description":"Liveness: the process runs."},"role":{"type":"string","enum":["api","worker"],"description":"DDR_ROLE of this process."}},"required":["status","role"],"description":"GET /healthz response."}}}}}}},"/readyz":{"get":{"operationId":"getReadiness","summary":"Readiness","responses":{"200":{"description":"Ready or not, with per-check results.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ready","not_ready"],"description":"Overall readiness."},"checks":{"type":"object","properties":{"database":{"type":"string","enum":["pass","fail"],"description":"One readiness check result."},"queue":{"type":"string","enum":["pass","fail"],"description":"One readiness check result."}},"description":"Per-dependency results. Absent when the dependency is not required for the role."}},"required":["status","checks"],"description":"GET /readyz response."}}}}}}},"/api/v1/t/{tenantId}/clients":{"post":{"operationId":"createClient","summary":"Create a client","description":"Creates a client of the tenant (MAT-01). Tenant mismatch answers 404.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200,"description":"Client name (firm-visible only, never in keys or logs)."},"kvkNumber":{"type":"string","nullable":true,"pattern":"^[0-9]{8}$","description":"KvK number of a business client (PRF-10, ADR-0058), e.g. taken over from the KvK lookup."},"address":{"type":"object","nullable":true,"properties":{"street":{"type":"string","nullable":true,"minLength":1,"maxLength":200},"postalCode":{"type":"string","nullable":true,"minLength":1,"maxLength":20},"city":{"type":"string","nullable":true,"minLength":1,"maxLength":100}},"required":["street","postalCode","city"],"description":"Client address (client data; scrubbed at tenant termination)."},"kind":{"type":"string","enum":["business","individual"],"description":"Business (default) or individual; a mortgage household is individual."}},"required":["name"],"description":"Create a client."}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Client id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"name":{"type":"string","nullable":true,"description":"Client name (scrubbed at tenant termination)."},"kvkNumber":{"type":"string","nullable":true,"description":"KvK number, when saved (PRF-10)."},"kind":{"type":"string","enum":["business","individual"],"description":"Business or individual (absent on older servers: business)."},"address":{"type":"object","nullable":true,"properties":{"street":{"type":"string","nullable":true,"minLength":1,"maxLength":200},"postalCode":{"type":"string","nullable":true,"minLength":1,"maxLength":20},"city":{"type":"string","nullable":true,"minLength":1,"maxLength":100}},"required":["street","postalCode","city"],"description":"Address, when saved (PRF-10)."},"roomCount":{"type":"integer","nullable":true,"minimum":0,"description":"Datarooms of this client across its matters, destroying/destroyed excluded (T-260922-c0d3). Absent on writes and in the in-memory store."},"dataroomState":{"type":"string","nullable":true,"enum":["active","frozen","closed","archived",null],"description":"Most advanced state among those datarooms (archived > closed > frozen > active), or null when the client has none (T-260922-c0d3). Computed by the server so the directory stops deriving it."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."}},"required":["id","tenantId","name","createdAt"],"description":"A client of the firm."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"get":{"operationId":"listClients","summary":"List visible clients","description":"Lists the clients of the tenant the principal may see (MAT-01, S-FIRM-02).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page size, 1-100 (default 50)."},"required":false,"description":"Page size, 1-100 (default 50).","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"description":"Rows to skip (default 0)."},"required":false,"description":"Rows to skip (default 0).","name":"offset","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":200,"description":"Substring match on the client name (server trims; empty means absent)."},"required":false,"description":"Substring match on the client name (server trims; empty means absent).","name":"search","in":"query"}],"responses":{"200":{"description":"Clients.","content":{"application/json":{"schema":{"type":"object","properties":{"clients":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Client id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"name":{"type":"string","nullable":true,"description":"Client name (scrubbed at tenant termination)."},"kvkNumber":{"type":"string","nullable":true,"description":"KvK number, when saved (PRF-10)."},"kind":{"type":"string","enum":["business","individual"],"description":"Business or individual (absent on older servers: business)."},"address":{"type":"object","nullable":true,"properties":{"street":{"type":"string","nullable":true,"minLength":1,"maxLength":200},"postalCode":{"type":"string","nullable":true,"minLength":1,"maxLength":20},"city":{"type":"string","nullable":true,"minLength":1,"maxLength":100}},"required":["street","postalCode","city"],"description":"Address, when saved (PRF-10)."},"roomCount":{"type":"integer","nullable":true,"minimum":0,"description":"Datarooms of this client across its matters, destroying/destroyed excluded (T-260922-c0d3). Absent on writes and in the in-memory store."},"dataroomState":{"type":"string","nullable":true,"enum":["active","frozen","closed","archived",null],"description":"Most advanced state among those datarooms (archived > closed > frozen > active), or null when the client has none (T-260922-c0d3). Computed by the server so the directory stops deriving it."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."}},"required":["id","tenantId","name","createdAt"],"description":"A client of the firm."},"description":"Clients the principal may see, newest first."}},"required":["clients"],"description":"List clients response."}}}},"400":{"description":"Invalid query.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"AUDIT_UNAVAILABLE: the audit event could not be written; nothing was served (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/matters":{"post":{"operationId":"createMatter","summary":"Create a matter","description":"Creates a matter of a client in the same tenant (MAT-01, MAT-02: matter number, practice area, responsible lawyer, counterparty, status, start/end date).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"clientId":{"type":"string","format":"uuid","description":"Client the matter belongs to (same tenant)."},"name":{"type":"string","nullable":true,"minLength":1,"maxLength":200,"description":"Matter name."},"reference":{"type":"string","nullable":true,"minLength":1,"maxLength":100,"description":"Matter number (dossiernummer)."},"practiceArea":{"type":"string","nullable":true,"minLength":1,"maxLength":100,"description":"Practice area (rechtsgebied), free text per firm."},"responsiblePrincipalId":{"type":"string","nullable":true,"format":"uuid","description":"Responsible lawyer (firm user of the same tenant)."},"counterparty":{"type":"string","nullable":true,"minLength":1,"maxLength":200,"description":"Counterparty (wederpartij), firm-visible only."},"status":{"type":"string","enum":["open","closed"],"description":"Initial status, defaults to open."},"startDate":{"type":"string","nullable":true,"format":"date","description":"Matter start date (YYYY-MM-DD)."},"endDate":{"type":"string","nullable":true,"format":"date","description":"Matter end date (YYYY-MM-DD)."}},"required":["clientId"],"description":"Create a matter."}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Matter id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"clientId":{"type":"string","format":"uuid","description":"Owning client."},"name":{"type":"string","nullable":true,"description":"Matter name."},"reference":{"type":"string","nullable":true,"description":"Matter number."},"practiceArea":{"type":"string","nullable":true,"description":"Practice area (rechtsgebied). Absent on pre-MAT-02 rows."},"responsiblePrincipalId":{"type":"string","nullable":true,"format":"uuid","description":"Responsible lawyer. Absent on pre-MAT-02 rows."},"counterparty":{"type":"string","nullable":true,"description":"Counterparty (wederpartij). Absent on pre-MAT-02 rows."},"status":{"type":"string","nullable":true,"enum":["open","closed",null],"description":"Matter status. Absent on pre-MAT-02 rows (treat as open)."},"startDate":{"type":"string","nullable":true,"format":"date","description":"Matter start date (YYYY-MM-DD). Absent on pre-MAT-02 rows."},"endDate":{"type":"string","nullable":true,"format":"date","description":"Matter end date (YYYY-MM-DD). Absent on pre-MAT-02 rows."},"documentCount":{"type":"integer","nullable":true,"minimum":0,"description":"Live documents across the matter's datarooms: not deleted, not trashed, destroying/destroyed rooms and placeholder rows excluded (T-260922-c0d3). Absent on writes and in the in-memory store."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."}},"required":["id","tenantId","clientId","name","reference","createdAt"],"description":"A matter of a client."}}}},"400":{"description":"Invalid request (including end date before start date).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"get":{"operationId":"listMatters","summary":"List visible matters","description":"Lists the matters of the tenant the principal may see (MAT-01, MAT-02, S-FIRM-04: filterable by status, practice area, responsible lawyer; search by matter number, matter name or client name).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page size, 1-100 (default 50)."},"required":false,"description":"Page size, 1-100 (default 50).","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"description":"Rows to skip (default 0)."},"required":false,"description":"Rows to skip (default 0).","name":"offset","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Only matters of this client."},"required":false,"description":"Only matters of this client.","name":"clientId","in":"query"},{"schema":{"type":"string","enum":["open","closed"],"description":"Only matters with this status."},"required":false,"description":"Only matters with this status.","name":"status","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":100,"description":"Only matters with this practice area (exact match)."},"required":false,"description":"Only matters with this practice area (exact match).","name":"practiceArea","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Only matters owned by this lawyer (\"me\" resolves client-side)."},"required":false,"description":"Only matters owned by this lawyer (\"me\" resolves client-side).","name":"responsiblePrincipalId","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":200,"description":"Substring match on matter number, matter name or client name."},"required":false,"description":"Substring match on matter number, matter name or client name.","name":"search","in":"query"}],"responses":{"200":{"description":"Matters.","content":{"application/json":{"schema":{"type":"object","properties":{"matters":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Matter id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"clientId":{"type":"string","format":"uuid","description":"Owning client."},"name":{"type":"string","nullable":true,"description":"Matter name."},"reference":{"type":"string","nullable":true,"description":"Matter number."},"practiceArea":{"type":"string","nullable":true,"description":"Practice area (rechtsgebied). Absent on pre-MAT-02 rows."},"responsiblePrincipalId":{"type":"string","nullable":true,"format":"uuid","description":"Responsible lawyer. Absent on pre-MAT-02 rows."},"counterparty":{"type":"string","nullable":true,"description":"Counterparty (wederpartij). Absent on pre-MAT-02 rows."},"status":{"type":"string","nullable":true,"enum":["open","closed",null],"description":"Matter status. Absent on pre-MAT-02 rows (treat as open)."},"startDate":{"type":"string","nullable":true,"format":"date","description":"Matter start date (YYYY-MM-DD). Absent on pre-MAT-02 rows."},"endDate":{"type":"string","nullable":true,"format":"date","description":"Matter end date (YYYY-MM-DD). Absent on pre-MAT-02 rows."},"documentCount":{"type":"integer","nullable":true,"minimum":0,"description":"Live documents across the matter's datarooms: not deleted, not trashed, destroying/destroyed rooms and placeholder rows excluded (T-260922-c0d3). Absent on writes and in the in-memory store."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."}},"required":["id","tenantId","clientId","name","reference","createdAt"],"description":"A matter of a client."},"description":"Matters the principal may see, newest first."}},"required":["matters"],"description":"List matters response."}}}},"400":{"description":"Invalid query.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"AUDIT_UNAVAILABLE: the audit event could not be written; nothing was served (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/clients/{clientId}":{"get":{"operationId":"getClient","summary":"Read a client","description":"Reads one client the principal may see (MAT-01).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Client id."},"required":true,"description":"Client id.","name":"clientId","in":"path"}],"responses":{"200":{"description":"Client.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Client id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"name":{"type":"string","nullable":true,"description":"Client name (scrubbed at tenant termination)."},"kvkNumber":{"type":"string","nullable":true,"description":"KvK number, when saved (PRF-10)."},"kind":{"type":"string","enum":["business","individual"],"description":"Business or individual (absent on older servers: business)."},"address":{"type":"object","nullable":true,"properties":{"street":{"type":"string","nullable":true,"minLength":1,"maxLength":200},"postalCode":{"type":"string","nullable":true,"minLength":1,"maxLength":20},"city":{"type":"string","nullable":true,"minLength":1,"maxLength":100}},"required":["street","postalCode","city"],"description":"Address, when saved (PRF-10)."},"roomCount":{"type":"integer","nullable":true,"minimum":0,"description":"Datarooms of this client across its matters, destroying/destroyed excluded (T-260922-c0d3). Absent on writes and in the in-memory store."},"dataroomState":{"type":"string","nullable":true,"enum":["active","frozen","closed","archived",null],"description":"Most advanced state among those datarooms (archived > closed > frozen > active), or null when the client has none (T-260922-c0d3). Computed by the server so the directory stops deriving it."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."}},"required":["id","tenantId","name","createdAt"],"description":"A client of the firm."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"AUDIT_UNAVAILABLE: the audit event could not be written; nothing was served (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/matters/{matterId}":{"get":{"operationId":"getMatter","summary":"Read a matter","description":"Reads one matter the principal may see, with its MAT-02 fields (S-FIRM-05).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Matter id."},"required":true,"description":"Matter id.","name":"matterId","in":"path"}],"responses":{"200":{"description":"Matter.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Matter id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"clientId":{"type":"string","format":"uuid","description":"Owning client."},"name":{"type":"string","nullable":true,"description":"Matter name."},"reference":{"type":"string","nullable":true,"description":"Matter number."},"practiceArea":{"type":"string","nullable":true,"description":"Practice area (rechtsgebied). Absent on pre-MAT-02 rows."},"responsiblePrincipalId":{"type":"string","nullable":true,"format":"uuid","description":"Responsible lawyer. Absent on pre-MAT-02 rows."},"counterparty":{"type":"string","nullable":true,"description":"Counterparty (wederpartij). Absent on pre-MAT-02 rows."},"status":{"type":"string","nullable":true,"enum":["open","closed",null],"description":"Matter status. Absent on pre-MAT-02 rows (treat as open)."},"startDate":{"type":"string","nullable":true,"format":"date","description":"Matter start date (YYYY-MM-DD). Absent on pre-MAT-02 rows."},"endDate":{"type":"string","nullable":true,"format":"date","description":"Matter end date (YYYY-MM-DD). Absent on pre-MAT-02 rows."},"documentCount":{"type":"integer","nullable":true,"minimum":0,"description":"Live documents across the matter's datarooms: not deleted, not trashed, destroying/destroyed rooms and placeholder rows excluded (T-260922-c0d3). Absent on writes and in the in-memory store."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."}},"required":["id","tenantId","clientId","name","reference","createdAt"],"description":"A matter of a client."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"AUDIT_UNAVAILABLE: the audit event could not be written; nothing was served (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/matters/{matterId}/rooms":{"get":{"operationId":"listMatterRooms","summary":"List rooms of a matter","description":"Lists the rooms of one matter the principal may see (MAT-06: multiple rooms per matter).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Matter id."},"required":true,"description":"Matter id.","name":"matterId","in":"path"}],"responses":{"200":{"description":"Rooms of the matter.","content":{"application/json":{"schema":{"type":"object","properties":{"rooms":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Room id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"matterId":{"type":"string","nullable":true,"format":"uuid","description":"Owning matter."},"name":{"type":"string","nullable":true,"description":"Room name."},"type":{"type":"string","description":"Room type."},"state":{"type":"string","enum":["active","frozen","closed","archived"],"description":"Room states visible through this API (destroying/destroyed are never listed)."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."},"metrics":{"type":"object","properties":{"documentCount":{"type":"integer","minimum":0,"description":"Documents in the room (trash excluded)."},"memberCount":{"type":"integer","minimum":0,"description":"Distinct principals with a membership in the room (ADR-0005 §4)."},"openRequestCount":{"type":"integer","minimum":0,"description":"Upload sessions still open in the room (DOC-14 open requests)."},"storageUsedBytes":{"type":"integer","minimum":0,"description":"Original file bytes for clean, not-yet-destroyed room blobs, all versions included; encryption overhead excluded."},"storageQuotaBytes":{"type":"integer","nullable":true,"minimum":0,"description":"Effective shared office storage allowance in bytes; null when unavailable."}},"required":["documentCount","memberCount","openRequestCount","storageUsedBytes","storageQuotaBytes"],"description":"Dataroom metrics (UX-04); omitted when unknown."},"edition":{"type":"string","enum":["general","transaction","legal","finance","corporate"],"description":"Room edition (DRE-3); omitted by older servers."}},"required":["id","tenantId","matterId","name","type","state","createdAt"],"description":"A data room."},"description":"Rooms the principal may see, newest first."}},"required":["rooms"],"description":"List rooms response."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms":{"post":{"operationId":"createRoom","summary":"Create a room","description":"Creates a client_portal or litigation room of a matter (MAT-01, MAT-06).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"matterId":{"type":"string","nullable":true,"format":"uuid","description":"Same-tenant matter, or null for a standalone dataroom."},"name":{"type":"string","minLength":1,"maxLength":200,"description":"Room name."},"type":{"type":"string","enum":["client_portal","litigation"],"description":"Room type of the minimal slice."}},"required":["matterId","name","type"],"description":"Create a room."}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Room id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"matterId":{"type":"string","nullable":true,"format":"uuid","description":"Owning matter."},"name":{"type":"string","nullable":true,"description":"Room name."},"type":{"type":"string","description":"Room type."},"state":{"type":"string","enum":["active","frozen","closed","archived"],"description":"Room states visible through this API (destroying/destroyed are never listed)."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."},"metrics":{"type":"object","properties":{"documentCount":{"type":"integer","minimum":0,"description":"Documents in the room (trash excluded)."},"memberCount":{"type":"integer","minimum":0,"description":"Distinct principals with a membership in the room (ADR-0005 §4)."},"openRequestCount":{"type":"integer","minimum":0,"description":"Upload sessions still open in the room (DOC-14 open requests)."},"storageUsedBytes":{"type":"integer","minimum":0,"description":"Original file bytes for clean, not-yet-destroyed room blobs, all versions included; encryption overhead excluded."},"storageQuotaBytes":{"type":"integer","nullable":true,"minimum":0,"description":"Effective shared office storage allowance in bytes; null when unavailable."}},"required":["documentCount","memberCount","openRequestCount","storageUsedBytes","storageQuotaBytes"],"description":"Dataroom metrics (UX-04); omitted when unknown."},"edition":{"type":"string","enum":["general","transaction","legal","finance","corporate"],"description":"Room edition (DRE-3); omitted by older servers."}},"required":["id","tenantId","matterId","name","type","state","createdAt"],"description":"A data room."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"get":{"operationId":"listRooms","summary":"List visible rooms","description":"Lists the rooms of the tenant the principal may see (MAT-06, S-FIRM-04 room-type filter lives here). Filter by matter for MAT-06 multiple rooms per matter. Each room carries the UX-04 `metrics` block (documents, members, open requests and storage) when the read model can compute it.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page size, 1-100 (default 50)."},"required":false,"description":"Page size, 1-100 (default 50).","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"description":"Rows to skip (default 0)."},"required":false,"description":"Rows to skip (default 0).","name":"offset","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Only rooms of this matter (MAT-06)."},"required":false,"description":"Only rooms of this matter (MAT-06).","name":"matterId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Only rooms whose matter belongs to this client."},"required":false,"description":"Only rooms whose matter belongs to this client.","name":"clientId","in":"query"},{"schema":{"type":"string","enum":["client_portal","litigation"],"description":"Only rooms of this type."},"required":false,"description":"Only rooms of this type.","name":"type","in":"query"},{"schema":{"type":"string","enum":["active","frozen","closed","archived"],"description":"Only rooms in this state."},"required":false,"description":"Only rooms in this state.","name":"state","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":100,"description":"Substring match on the room name (server trims; blank means absent)."},"required":false,"description":"Substring match on the room name (server trims; blank means absent).","name":"search","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":100,"description":"Substring match on the matter number (server trims; blank means absent)."},"required":false,"description":"Substring match on the matter number (server trims; blank means absent).","name":"matterReference","in":"query"}],"responses":{"200":{"description":"Rooms.","content":{"application/json":{"schema":{"type":"object","properties":{"rooms":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Room id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"matterId":{"type":"string","nullable":true,"format":"uuid","description":"Owning matter."},"name":{"type":"string","nullable":true,"description":"Room name."},"type":{"type":"string","description":"Room type."},"state":{"type":"string","enum":["active","frozen","closed","archived"],"description":"Room states visible through this API (destroying/destroyed are never listed)."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."},"metrics":{"type":"object","properties":{"documentCount":{"type":"integer","minimum":0,"description":"Documents in the room (trash excluded)."},"memberCount":{"type":"integer","minimum":0,"description":"Distinct principals with a membership in the room (ADR-0005 §4)."},"openRequestCount":{"type":"integer","minimum":0,"description":"Upload sessions still open in the room (DOC-14 open requests)."},"storageUsedBytes":{"type":"integer","minimum":0,"description":"Original file bytes for clean, not-yet-destroyed room blobs, all versions included; encryption overhead excluded."},"storageQuotaBytes":{"type":"integer","nullable":true,"minimum":0,"description":"Effective shared office storage allowance in bytes; null when unavailable."}},"required":["documentCount","memberCount","openRequestCount","storageUsedBytes","storageQuotaBytes"],"description":"Dataroom metrics (UX-04); omitted when unknown."},"edition":{"type":"string","enum":["general","transaction","legal","finance","corporate"],"description":"Room edition (DRE-3); omitted by older servers."}},"required":["id","tenantId","matterId","name","type","state","createdAt"],"description":"A data room."},"description":"Rooms the principal may see, newest first."}},"required":["rooms"],"description":"List rooms response."}}}},"400":{"description":"Invalid query.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"AUDIT_UNAVAILABLE: the audit event could not be written; nothing was served (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}":{"get":{"operationId":"getRoom","summary":"Read a room","description":"Reads one room the principal may see, with the UX-04 `metrics` block (documents, members, open requests and storage) when the read model can compute it.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"Room.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Room id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"matterId":{"type":"string","nullable":true,"format":"uuid","description":"Owning matter."},"name":{"type":"string","nullable":true,"description":"Room name."},"type":{"type":"string","description":"Room type."},"state":{"type":"string","enum":["active","frozen","closed","archived"],"description":"Room states visible through this API (destroying/destroyed are never listed)."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."},"metrics":{"type":"object","properties":{"documentCount":{"type":"integer","minimum":0,"description":"Documents in the room (trash excluded)."},"memberCount":{"type":"integer","minimum":0,"description":"Distinct principals with a membership in the room (ADR-0005 §4)."},"openRequestCount":{"type":"integer","minimum":0,"description":"Upload sessions still open in the room (DOC-14 open requests)."},"storageUsedBytes":{"type":"integer","minimum":0,"description":"Original file bytes for clean, not-yet-destroyed room blobs, all versions included; encryption overhead excluded."},"storageQuotaBytes":{"type":"integer","nullable":true,"minimum":0,"description":"Effective shared office storage allowance in bytes; null when unavailable."}},"required":["documentCount","memberCount","openRequestCount","storageUsedBytes","storageQuotaBytes"],"description":"Dataroom metrics (UX-04); omitted when unknown."},"edition":{"type":"string","enum":["general","transaction","legal","finance","corporate"],"description":"Room edition (DRE-3); omitted by older servers."}},"required":["id","tenantId","matterId","name","type","state","createdAt"],"description":"A data room."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"First access requires accepting the effective room terms (TERMS_NOT_ACCEPTED, ORG-07).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"AUDIT_UNAVAILABLE: the audit event could not be written; nothing was served (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/terms":{"get":{"operationId":"getRoomTerms","summary":"Read the effective room terms","description":"Versioned terms of use / NDA for first room access (ORG-07, T-260914-7cc2): the firm default plus an optional room override, with whether the caller already accepted the effective version. Tenant mismatch or no room access answers 404.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","enum":["nl","en"],"description":"Terms language."},"required":false,"description":"Terms language.","name":"lang","in":"query"}],"responses":{"200":{"description":"Effective terms.","content":{"application/json":{"schema":{"type":"object","properties":{"effective":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Terms version id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"roomId":{"type":"string","nullable":true,"format":"uuid","description":"Room override, or null for the firm default."},"version":{"type":"integer","minimum":1,"description":"Version number within the scope."},"lang":{"type":"string","enum":["nl","en"],"description":"Terms language."},"title":{"type":"string","minLength":1,"maxLength":200,"description":"First heading of the legal text."},"bodyMarkdown":{"type":"string","minLength":1,"maxLength":50000,"description":"Terms text as stored and shown, with {{firmName}}/{{roomName}} substituted by the caller before publishing."},"sha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"SHA-256 (hex) of the exact stored text `title + \"\\n\" + bodyMarkdown`; the acceptance and audit record this hash."},"createdAt":{"type":"string","format":"date-time","description":"Publication timestamp."}},"required":["id","tenantId","roomId","version","lang","title","bodyMarkdown","sha256","createdAt"],"description":"Terms the principal must accept now."},"accepted":{"type":"boolean","description":"Whether the principal already accepted this version."},"versions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Terms version id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"roomId":{"type":"string","nullable":true,"format":"uuid","description":"Room override, or null for the firm default."},"version":{"type":"integer","minimum":1,"description":"Version number within the scope."},"lang":{"type":"string","enum":["nl","en"],"description":"Terms language."},"title":{"type":"string","minLength":1,"maxLength":200,"description":"First heading of the legal text."},"bodyMarkdown":{"type":"string","minLength":1,"maxLength":50000,"description":"Terms text as stored and shown, with {{firmName}}/{{roomName}} substituted by the caller before publishing."},"sha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"SHA-256 (hex) of the exact stored text `title + \"\\n\" + bodyMarkdown`; the acceptance and audit record this hash."},"createdAt":{"type":"string","format":"date-time","description":"Publication timestamp."}},"required":["id","tenantId","roomId","version","lang","title","bodyMarkdown","sha256","createdAt"],"description":"One published version of the room terms."},"description":"All versions of the scope (newest first)."}},"required":["effective","accepted","versions"],"description":"Effective room terms with acceptance state."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant and no access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/terms/accept":{"post":{"operationId":"acceptRoomTerms","summary":"Accept the room terms","description":"Records acceptance of the effective version (principal, version, time, IP server-side) and emits room_terms.accepted with the version id and its sha256 (IDs and a hash only, never the terms text or IP). Re-accepting the same version is idempotent.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"termsVersionId":{"type":"string","format":"uuid","description":"Version the principal accepts."}},"required":["termsVersionId"],"description":"Accept the effective room terms."}}}},"responses":{"200":{"description":"Accepted.","content":{"application/json":{"schema":{"type":"object","properties":{"acceptedAt":{"type":"string","format":"date-time","description":"Acceptance timestamp."},"termsVersionId":{"type":"string","format":"uuid","description":"Accepted version id."}},"required":["acceptedAt","termsVersionId"],"description":"Terms acceptance confirmation (no PII)."}}}},"400":{"description":"Invalid request (unknown or stale version).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant and no access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/terms":{"post":{"operationId":"publishRoomTerms","summary":"Publish a new version of the room terms","description":"Firm admin only: publishes the next version of the firm default or of one room override (re-prompts every member). Tenant mismatch answers 404.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"roomId":{"type":"string","nullable":true,"format":"uuid","description":"Room override, or omitted for the firm default."},"lang":{"type":"string","enum":["nl","en"],"description":"Terms language."},"title":{"type":"string","minLength":1,"maxLength":200,"description":"First heading."},"bodyMarkdown":{"type":"string","minLength":1,"maxLength":50000,"description":"Terms text with {{firmName}}/{{roomName}} already substituted; the stored text is hashed for the acceptance record."}},"required":["lang","title","bodyMarkdown"],"description":"Publish a new version of the room terms (firm admin)."}}}},"responses":{"201":{"description":"Published.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Terms version id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"roomId":{"type":"string","nullable":true,"format":"uuid","description":"Room override, or null for the firm default."},"version":{"type":"integer","minimum":1,"description":"Version number within the scope."},"lang":{"type":"string","enum":["nl","en"],"description":"Terms language."},"title":{"type":"string","minLength":1,"maxLength":200,"description":"First heading of the legal text."},"bodyMarkdown":{"type":"string","minLength":1,"maxLength":50000,"description":"Terms text as stored and shown, with {{firmName}}/{{roomName}} substituted by the caller before publishing."},"sha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"SHA-256 (hex) of the exact stored text `title + \"\\n\" + bodyMarkdown`; the acceptance and audit record this hash."},"createdAt":{"type":"string","format":"date-time","description":"Publication timestamp."}},"required":["id","tenantId","roomId","version","lang","title","bodyMarkdown","sha256","createdAt"],"description":"One published version of the room terms."}}}},"400":{"description":"Invalid request.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/receipts/{versionId}":{"get":{"operationId":"downloadReceipt","summary":"Download an upload receipt (PDF)","description":"Per-upload PDF receipt (AUD-09, T-260914-6f6c): timestamp, SHA-256 of the original, uploader and room reference. The uploader downloads their own receipt; managers download any receipt of the room. A guest downloads only their own receipt. Emits receipt.downloaded.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document version id the receipt covers."},"required":true,"description":"Document version id the receipt covers.","name":"versionId","in":"path"}],"responses":{"200":{"description":"PDF receipt (application/pdf)."},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant and foreign receipts).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"AUDIT_UNAVAILABLE: the audit event could not be written; nothing was served (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/pages/{pageNo}":{"get":{"operationId":"getDocumentPage","summary":"Render one document page with a per-request watermark","description":"Secure viewer page (T-260913-1690, VIEW-01/02/03/12, ADR-0011 D9/D12). Serves the worker-rendered WebP page image with the personal watermark (name, email, time, IP, forensic id) drawn per request in memory, never stored (STORAGE 6.3). Sends Cache-Control: no-store. Writes document.page_viewed only when an image is served. A page whose derivative is not ready enqueues render.page for a window of DDR_RENDER_WINDOW_PAGES pages and waits up to DDR_RENDER_WAIT_MS; still rendering answers 202 PAGE_RENDERING with Retry-After: 2 and no audit event. Requires room access; 404 hides existence (including cross-tenant, PERM-02). A blob in the archived or restoring tier answers 409 SOURCE_UNAVAILABLE (ADR-0007 D8). This URL is the deep link to a page (VIEW-12); permissions still apply. Interim behaviour (registered by T-260916-b61a, replaced by T-260915-86e7): the route exists and requires a session; it authorizes document.view through the central policy module, and while the worker render pipeline and the per-request watermark drawing are not wired (T-260915-86e7, needs T-260914-4474) it answers 404 NOT_FOUND for every page it cannot serve - the same body a hidden or missing document gives, so nothing leaks, and it never answers 500. No document.page_viewed is written yet (ADR-0006 D4: the event is written only when an image is served). The 200 image, the 202 PAGE_RENDERING window and the 409 SOURCE_UNAVAILABLE above describe the target behaviour that T-260915-86e7 wires up.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"},{"schema":{"type":"string","pattern":"^[1-9][0-9]{0,5}$","description":"1-based page number (1..999999, server refuses above 100000)."},"required":true,"description":"1-based page number (1..999999, server refuses above 100000).","name":"pageNo","in":"path"},{"schema":{"type":"string","enum":["thumb","page","page-hd"],"description":"Render profile (default page)."},"required":false,"description":"Render profile (default page).","name":"profile","in":"query"}],"responses":{"200":{"description":"Watermarked page image (WebP). Cache-Control: no-store. document.page_viewed is written before the first byte.","headers":{"X-Page-Count":{"schema":{"type":"string","pattern":"^[1-9][0-9]*$","description":"Total pages of the served document version (ADR-0023), so the viewer can build its page list from page 1."},"required":true,"description":"Total pages of the served document version (ADR-0023), so the viewer can build its page list from page 1."}},"content":{"image/webp":{"schema":{"type":"string","description":"Watermarked page image bytes (WebP, worker-rendered)."}}}},"202":{"description":"Page still rendering (code PAGE_RENDERING, Retry-After: 2). No audit event; retry the same URL.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"400":{"description":"Invalid page number or profile.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without room access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Render source unavailable (code SOURCE_UNAVAILABLE, archived/restoring tier).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"The document.page_viewed audit event could not be written, so nothing is served (code AUDIT_UNAVAILABLE, ADR-0006 D5 fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/versions/{versionNo}/processing":{"get":{"operationId":"getProcessingStatus","summary":"Processing status of one document version","description":"Per-version state machine (T-260914-1b7b, DOC-07, ADR-0011 D7): version-level state (uploading, scanning, processing, ready, limited, rejected, failed) plus per-step states with D8 failure and warning codes (never content, paths or tool output). Requires document view access; 404 hides existence (including cross-tenant, PERM-02). Status reads are not audited (ADR-0006 D4).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"},{"schema":{"type":"string","pattern":"^[1-9][0-9]{0,8}$","description":"1-based version number."},"required":true,"description":"1-based version number.","name":"versionNo","in":"path"}],"responses":{"200":{"description":"Processing status of the version.","content":{"application/json":{"schema":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","description":"Document version id."},"versionNo":{"type":"integer","minimum":1,"description":"1-based version number."},"versionStatus":{"type":"string","enum":["uploading","scanning","available","rejected","failed"],"description":"Document version status (ADR-0007 D3)."},"state":{"type":"string","enum":["uploading","scanning","processing","ready","limited","rejected","failed"],"description":"Version-level processing state shown in the index UI and version panel (ADR-0011 D7)."},"steps":{"type":"array","items":{"type":"object","properties":{"step":{"type":"string","enum":["scan","convert","text","index","thumbnail"],"description":"Processing step (ADR-0011 D7)."},"status":{"type":"string","enum":["pending","queued","running","ready","skipped","failed","purged"],"description":"Processing step status (ADR-0011 D7)."},"failureCode":{"type":"string","nullable":true,"enum":["MALWARE_FOUND","TYPE_MISMATCH","TYPE_BLOCKED","ARCHIVE_LIMIT","ENCRYPTED_ARCHIVE","MACRO_REJECTED","SCAN_ERROR","SCAN_TIMEOUT","NOT_NEEDED","UNSUPPORTED_TYPE","INPUT_TOO_LARGE","PASSWORD_PROTECTED","UNREADABLE","PAGE_LIMIT","DEPENDENCY_FAILED","SOURCE_REJECTED","SOURCE_UNAVAILABLE","TOOL_TIMEOUT","RESOURCE_LIMIT","TOOL_ERROR","WORKER_LOST","CONVERTER_UNAVAILABLE","CONVERTER_PROTOCOL_ERROR","OBJECT_EXISTS","OUTPUT_IN_PROGRESS","KEY_VERSION_NOT_ACTIVE",null],"description":"D8 code for failed and skipped steps, else null."},"warningCodes":{"type":"array","items":{"type":"string","enum":["MACROS_PRESENT","SCAN_SIZE_LIMIT","SCAN_PARTIAL","OCR_PAGE_LIMIT","OCR_LOW_CONFIDENCE","PARTIAL_TEXT","FONTS_SUBSTITUTED","ATTACHMENTS_NOT_PROCESSED"],"description":"Processing warning code (ADR-0011 D8)."},"description":"D8 warning codes of a ready step."}},"required":["step","status","failureCode","warningCodes"],"description":"Processing state of one step (ADR-0011 D7)."},"description":"Per-step states in pipeline order."},"currentStep":{"type":"string","nullable":true,"enum":["scan","convert","text","index","thumbnail",null],"description":"Step the pipeline is working on while state is scanning or processing, else null."},"retryable":{"type":"boolean","description":"True when a failed step can be retried (D14)."}},"required":["versionId","versionNo","versionStatus","state","steps","currentStep","retryable"],"description":"Processing status of one document version (ADR-0011 D7)."}}}},"400":{"description":"Invalid version number.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without room access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/firm-branding":{"get":{"operationId":"getFirmBranding","summary":"Read firm branding","description":"Firm branding of a tenant (T-260914-41c5, UX-02, visual-identity §13): brand colour, derived OKLCH scale, full/decoration-only mode with the hue guard outcome and computed ratios (the admin preview model), logo and stylesheet URLs. Requires tenant.settings.update; 404 hides existence (including cross-tenant, PERM-02).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"Firm branding with preview ratios and the applied fallback.","content":{"application/json":{"schema":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"brandColour":{"type":"string","nullable":true,"pattern":"^#[0-9a-fA-F]{6}$","description":"Set brand colour, or null for the cobalt default."},"scale":{"type":"object","properties":{"50":{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Scale step 50."},"100":{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Scale step 100."},"200":{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Scale step 200."},"600":{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Scale step 600 (actions)."},"700":{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Scale step 700 (actions hover)."},"800":{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Scale step 800."}},"required":["50","100","200","600","700","800"],"description":"Derived scale (of the brand colour, or cobalt when unset)."},"mode":{"type":"string","enum":["full","decoration-only"],"description":"Whether the brand colour replaces cobalt actions or stays decorative."},"hueGuard":{"type":"object","properties":{"danger":{"type":"boolean","description":"True when within +-20 degrees of the danger hue."},"internal":{"type":"boolean","description":"True when within +-20 degrees of the internal-only hue."}},"required":["danger","internal"],"description":"Hue guard outcome (either true forces decoration-only)."},"ratios":{"type":"object","properties":{"textOn600":{"type":"number","description":"White text on step 600 (needs >= 4.5 for full mode)."},"textOn700":{"type":"number","description":"White text on step 700 (needs >= 4.5 for full mode)."},"fillOnTrack":{"type":"number","description":"Step 600 on step 100 (needs >= 3 for full mode)."},"fillOnWhite":{"type":"number","description":"Step 600 on white (needs >= 3 for full mode)."}},"required":["textOn600","textOn700","fillOnTrack","fillOnWhite"],"description":"Computed contrast ratios for the branding decision."},"logo":{"type":"object","nullable":true,"properties":{"format":{"type":"string","enum":["svg","png"],"description":"Stored logo format."},"url":{"type":"string","description":"Same-origin logo URL (served from our origin)."},"version":{"type":"integer","minimum":1,"description":"Logo version for cache busting."}},"required":["format","url","version"],"description":"Stored logo, or null when none is set."},"stylesheetUrl":{"type":"string","description":"Same-origin per-tenant stylesheet URL (CSS variables)."}},"required":["tenantId","brandColour","scale","mode","hueGuard","ratios","logo","stylesheetUrl"],"description":"Firm branding of a tenant, with the preview ratios and the applied fallback."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (non-admins) or step-up required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"put":{"operationId":"updateFirmBranding","summary":"Update firm branding","description":"Sets the brand colour (#rrggbb, null resets to cobalt) and the logo (SVG sanitised server-side, or PNG; null removes it). Firm admins only (tenant.settings.update with step-up). Emits tenant.settings_changed with setting_codes [\"firm_branding\"].","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"brandColour":{"type":"string","nullable":true,"pattern":"^#[0-9a-fA-F]{6}$","description":"New brand colour, or null to reset to cobalt."},"logo":{"type":"object","nullable":true,"properties":{"format":{"type":"string","enum":["svg","png"],"description":"Logo format."},"content":{"type":"string","minLength":1,"maxLength":350000,"description":"Raw SVG text, or base64 PNG bytes."}},"required":["format","content"],"description":"New logo, or null to remove it. Omitted to keep it."}},"required":["brandColour"],"description":"Update firm branding (logo and brand colour)."}}}},"responses":{"200":{"description":"Stored branding with preview ratios and the applied fallback.","content":{"application/json":{"schema":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"brandColour":{"type":"string","nullable":true,"pattern":"^#[0-9a-fA-F]{6}$","description":"Set brand colour, or null for the cobalt default."},"scale":{"type":"object","properties":{"50":{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Scale step 50."},"100":{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Scale step 100."},"200":{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Scale step 200."},"600":{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Scale step 600 (actions)."},"700":{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Scale step 700 (actions hover)."},"800":{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Scale step 800."}},"required":["50","100","200","600","700","800"],"description":"Derived scale (of the brand colour, or cobalt when unset)."},"mode":{"type":"string","enum":["full","decoration-only"],"description":"Whether the brand colour replaces cobalt actions or stays decorative."},"hueGuard":{"type":"object","properties":{"danger":{"type":"boolean","description":"True when within +-20 degrees of the danger hue."},"internal":{"type":"boolean","description":"True when within +-20 degrees of the internal-only hue."}},"required":["danger","internal"],"description":"Hue guard outcome (either true forces decoration-only)."},"ratios":{"type":"object","properties":{"textOn600":{"type":"number","description":"White text on step 600 (needs >= 4.5 for full mode)."},"textOn700":{"type":"number","description":"White text on step 700 (needs >= 4.5 for full mode)."},"fillOnTrack":{"type":"number","description":"Step 600 on step 100 (needs >= 3 for full mode)."},"fillOnWhite":{"type":"number","description":"Step 600 on white (needs >= 3 for full mode)."}},"required":["textOn600","textOn700","fillOnTrack","fillOnWhite"],"description":"Computed contrast ratios for the branding decision."},"logo":{"type":"object","nullable":true,"properties":{"format":{"type":"string","enum":["svg","png"],"description":"Stored logo format."},"url":{"type":"string","description":"Same-origin logo URL (served from our origin)."},"version":{"type":"integer","minimum":1,"description":"Logo version for cache busting."}},"required":["format","url","version"],"description":"Stored logo, or null when none is set."},"stylesheetUrl":{"type":"string","description":"Same-origin per-tenant stylesheet URL (CSS variables)."}},"required":["tenantId","brandColour","scale","mode","hueGuard","ratios","logo","stylesheetUrl"],"description":"Firm branding of a tenant, with the preview ratios and the applied fallback."}}}},"400":{"description":"Invalid colour, logo or SVG content.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (non-admins) or step-up required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/versions/{versionNo}/processing/retry":{"post":{"operationId":"retryProcessing","summary":"Retry a failed processing step","description":"Manual retry (T-260914-1b7b, DOC-07, ADR-0011 D14): an authorized manager requeues a failed step of an available or failed version (attempt + 1) and requeues dependants skipped with DEPENDENCY_FAILED. Scan is never retried by users. The endpoint authorizes first (document_version.processing_retry); only then does retrying a step that is not failed answer 409 PROCESSING_NOT_FAILED. Writes processing.retried (ADR-0011 D17).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"},{"schema":{"type":"string","pattern":"^[1-9][0-9]{0,8}$","description":"1-based version number."},"required":true,"description":"1-based version number.","name":"versionNo","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"step":{"type":"string","enum":["scan","convert","text","index","thumbnail"],"description":"Failed step to retry (scan is never retried by users)."}},"required":["step"],"description":"Manual processing retry (ADR-0011 D14)."}}}},"responses":{"200":{"description":"Retry queued (attempt + 1).","content":{"application/json":{"schema":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","description":"Document version id."},"step":{"type":"string","enum":["scan","convert","text","index","thumbnail"],"description":"Processing step (ADR-0011 D7)."},"attempt":{"type":"integer","minimum":1,"description":"New attempt number (previous attempt + 1)."},"state":{"type":"string","enum":["uploading","scanning","processing","ready","limited","rejected","failed"],"description":"Version-level state after the retry was queued."}},"required":["versionId","step","attempt","state"],"description":"Manual processing retry receipt (ADR-0011 D14)."}}}},"400":{"description":"Invalid version number or step.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without room access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Step is not failed or not retryable (code PROCESSING_NOT_FAILED); scan retries are refused the same way.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/firm-branding/stylesheet":{"get":{"operationId":"getBrandingStylesheet","summary":"Per-tenant branding stylesheet","description":"Serves the derived brand scale as CSS variables (text/css, Cache-Control: public with an etag over the branding version). Public by design: the portal and sign-in pages link it before anyone signs in (ADR-0010 D8: variables, never style attributes). Carries no names or content, only colours.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"CSS variables for the tenant brand (text/css).","content":{"text/css":{"schema":{"type":"string","description":"Tenant brand stylesheet (CSS custom properties)."}}}},"404":{"description":"Unknown tenant.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/firm-branding/logo":{"get":{"operationId":"getBrandingLogo","summary":"Firm logo","description":"Serves the stored logo from our origin (sanitised SVG or verified PNG, Cache-Control: public with a version query). Public by design: the portal header, sign-in panel and emails embed it without a session. 404 when no logo is set or the tenant is unknown.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"Logo bytes (image/svg+xml or image/png).","content":{"image/svg+xml":{"schema":{"type":"string","description":"Sanitised SVG logo bytes."}},"image/png":{"schema":{"type":"string","description":"PNG logo bytes (base64 in the document, binary on the wire)."}}}},"404":{"description":"No logo set or unknown tenant.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/flow-templates":{"get":{"operationId":"listFlowTemplates","summary":"List flow templates","description":"Organisation templates and read-only system starters the principal may use (INT-F01). Requires flow_template.read; 404 hides existence (including cross-tenant, PERM-02). Navigation read: no audit event. The request-flow profile (ADR-0025) answers `{ templates }` of built-in and docs/tasks/E20 starters.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"Templates.","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"templates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"tenantId":{"type":"string","format":"uuid"},"name":{"type":"string"},"state":{"type":"string","enum":["active","archived"],"description":"Template lifecycle state."},"latestPublishedVersionNo":{"type":"integer","nullable":true,"minimum":1},"draftVersionNo":{"type":"integer","nullable":true,"minimum":1},"copiedFrom":{"type":"object","nullable":true,"properties":{"templateId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":1}},"required":["templateId","versionNo"],"description":"Set on organisation copies of a starter template (INT-F01)."},"isSystemTemplate":{"type":"boolean","description":"True for read-only system starters (tenant_id NULL)."},"newerSystemVersionAvailable":{"type":"boolean","description":"A newer system version exists; the copy does not change by itself (INT-F01)."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","tenantId","name","state","latestPublishedVersionNo","draftVersionNo","copiedFrom","isSystemTemplate","newerSystemVersionAvailable","createdAt","updatedAt"],"description":"Organisation flow template (INT-F01)."}}},"required":["templates"],"description":"Templates visible to the principal, newest first."},{"type":"object","properties":{"templates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","maxLength":100},"name":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"description":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"profession":{"type":"string","enum":["legal","mortgage","notary","accounting","insolvency","general"],"description":"Profession a request template is made for."},"builtIn":{"type":"boolean","description":"False for a template the firm saved (editable)."},"coverInstructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Cover \"Instructies\" page of requests made from this template."},"participants":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Expected answer slot of this participant."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the participant (firm dossier vocabulary)."}},"required":["slot","label"],"description":"Expected participant of a firm template: answer slot plus display label."},"maxItems":10,"description":"Expected named slots of this template (roles only); absent on unrostered templates."},"updatedAt":{"type":"string","format":"date-time"},"contentHash":{"type":"string","pattern":"^[a-f0-9]{64}$","description":"Exact content fingerprint of a saved firm template (SP07). Required to pin a firm template reference in a versioned dossier pack; absent for read-only built-in starters, whose version is 1."},"sections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"items":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Instruction text in the safe rich-text subset (ADR-0048)."},"footnote":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"Defaults to `file`."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false},"maxItems":30}},"additionalProperties":false,"description":"Template answer rules (ADR-0048)."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named item icon of the request form (ADR-0048); the web maps it onto the icon set."},"required":{"type":"boolean"},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for; null or absent is shared."},"allowNotApplicable":{"type":"boolean","description":"Defaults to the inverse of `required`."},"allowMultiple":{"type":"boolean","description":"Defaults to true."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50},"targetPath":{"type":"string","nullable":true,"maxLength":200,"description":"Title of a top-level room folder."},"bsnAutoMask":{"type":"boolean","description":"Default of the item: burn every BSN out of a delivered file (ADR-0053)."},"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650,"description":"Default validity rule of the item in days (ADR-0053)."}},"required":["title","instructions","required","targetPath"],"description":"Template item."},"maxItems":100},"subsections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"items":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Instruction text in the safe rich-text subset (ADR-0048)."},"footnote":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"Defaults to `file`."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false},"maxItems":30}},"additionalProperties":false,"description":"Template answer rules (ADR-0048)."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named item icon of the request form (ADR-0048); the web maps it onto the icon set."},"required":{"type":"boolean"},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for; null or absent is shared."},"allowNotApplicable":{"type":"boolean","description":"Defaults to the inverse of `required`."},"allowMultiple":{"type":"boolean","description":"Defaults to true."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50},"targetPath":{"type":"string","nullable":true,"maxLength":200,"description":"Title of a top-level room folder."},"bsnAutoMask":{"type":"boolean","description":"Default of the item: burn every BSN out of a delivered file (ADR-0053)."},"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650,"description":"Default validity rule of the item in days (ADR-0053)."}},"required":["title","instructions","required","targetPath"],"description":"Template item."},"maxItems":100}},"required":["title","items"],"description":"Sub-section of a template (one level, ADR-0048)."},"maxItems":50},"repeat":{"type":"object","nullable":true,"properties":{"min":{"type":"integer","minimum":0,"maximum":10,"description":"Fewest repeats the client must add (0 = the group may be skipped)."},"max":{"type":"integer","minimum":1,"maximum":20,"description":"Most repeats the client may add."}},"required":["min","max"],"additionalProperties":false,"description":"Repeatable group (PRF-03): when present the section repeats min..max times (one block per repeat); absent or null is exactly one."}},"required":["title","items"],"description":"Section of a template, with optional sub-sections."}}},"required":["id","name","description","sections"],"description":"Request template (request-flow profile)."}}},"required":["templates"],"description":"Request templates (request-flow profile)."}]}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"post":{"operationId":"createFlowTemplate","summary":"Create a flow template","description":"Creates a blank template or a copy of a system/organisation template, recording `copied_from` (INT-F01). Requires flow_template.manage; a lawyer without the firm setting gets 403. Writes flow_template.created or flow_template.copied.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200,"description":"Template name. Warns when it looks like client data."},"copyFrom":{"type":"object","properties":{"templateId":{"type":"string","format":"uuid","description":"Source template (system starter or organisation template)."},"versionNo":{"type":"integer","minimum":1,"description":"Source version; defaults to the latest published."}},"required":["templateId"],"additionalProperties":false,"description":"Copy an existing template instead of starting blank (INT-F01)."}},"required":["name"],"additionalProperties":false,"description":"Create a flow template (INT-F01)."}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"tenantId":{"type":"string","format":"uuid"},"name":{"type":"string"},"state":{"type":"string","enum":["active","archived"],"description":"Template lifecycle state."},"latestPublishedVersionNo":{"type":"integer","nullable":true,"minimum":1},"draftVersionNo":{"type":"integer","nullable":true,"minimum":1},"copiedFrom":{"type":"object","nullable":true,"properties":{"templateId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":1}},"required":["templateId","versionNo"],"description":"Set on organisation copies of a starter template (INT-F01)."},"isSystemTemplate":{"type":"boolean","description":"True for read-only system starters (tenant_id NULL)."},"newerSystemVersionAvailable":{"type":"boolean","description":"A newer system version exists; the copy does not change by itself (INT-F01)."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","tenantId","name","state","latestPublishedVersionNo","draftVersionNo","copiedFrom","isSystemTemplate","newerSystemVersionAvailable","createdAt","updatedAt"],"description":"Organisation flow template (INT-F01)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no manage permission).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or source template.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/flow-templates/{templateId}":{"get":{"operationId":"getFlowTemplate","summary":"Read a flow template with its draft and latest version","description":"Template metadata plus the working draft and the latest published version (INT-F01, INT-F02). Requires flow_template.read; 404 hides existence (including cross-tenant).","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"templateId","in":"path"}],"responses":{"200":{"description":"Template detail.","content":{"application/json":{"schema":{"type":"object","properties":{"template":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"tenantId":{"type":"string","format":"uuid"},"name":{"type":"string"},"state":{"type":"string","enum":["active","archived"],"description":"Template lifecycle state."},"latestPublishedVersionNo":{"type":"integer","nullable":true,"minimum":1},"draftVersionNo":{"type":"integer","nullable":true,"minimum":1},"copiedFrom":{"type":"object","nullable":true,"properties":{"templateId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":1}},"required":["templateId","versionNo"],"description":"Set on organisation copies of a starter template (INT-F01)."},"isSystemTemplate":{"type":"boolean","description":"True for read-only system starters (tenant_id NULL)."},"newerSystemVersionAvailable":{"type":"boolean","description":"A newer system version exists; the copy does not change by itself (INT-F01)."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","tenantId","name","state","latestPublishedVersionNo","draftVersionNo","copiedFrom","isSystemTemplate","newerSystemVersionAvailable","createdAt","updatedAt"],"description":"Organisation flow template (INT-F01)."},"draft":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"templateId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":1},"state":{"type":"string","enum":["draft","published"],"description":"Template version state (INT-F02)."},"content":{"type":"object","properties":{"conditions":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"help":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional help text for the builder."},"defaultValue":{"type":"boolean","description":"Initial value in the builder."}},"required":["code","label","help","defaultValue"],"additionalProperties":false,"description":"Template condition (INT-F04)."},"maxItems":50,"description":"Conditions (INT-F04)."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Stable section id (absent on a fresh draft)."},"parentSectionId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section; a child of a child is refused (`SECTION_DEPTH`, INT-F04)."},"position":{"type":"integer","minimum":0,"description":"Order among its siblings."},"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional instructions above the items."},"defaultTargetPath":{"type":"string","nullable":true,"maxLength":500,"description":"Default target folder for the section."}},"required":["parentSectionId","position","title","instructions","defaultTargetPath"],"additionalProperties":false,"description":"Section of a template version or flow draft (INT-F04)."},"maxItems":200,"description":"Sections, one nesting level (INT-F04)."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Stable item id (absent on a fresh draft)."},"sectionId":{"type":"string","format":"uuid","description":"Section the item belongs to."},"position":{"type":"integer","minimum":0,"description":"Order within the section."},"type":{"type":"string","enum":["file","text","number","date","choice","acknowledgement","instructions"],"description":"Item type (INT-F05)."},"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional instructions shown with the item."},"required":{"type":"boolean","description":"Optional items never block completion (INT-F06)."},"allowNotApplicable":{"type":"boolean","description":"Offer \"Not applicable\" (default true for optional, false for required file items)."},"assignees":{"type":"array","items":{"type":"string","pattern":"^(client|all_recipients|organisation|applicant_[1-9][0-9]?)$","description":"Assignee slot: client, all_recipients, organisation or applicant_<n>."},"minItems":1,"maxItems":20,"description":"Slots that provide the item; `organisation` for firm-owned items."},"visibility":{"type":"string","enum":["assignees","internal","shared_on_approval"],"description":"Item visibility (INT-F06, INT-F07)."},"review":{"type":"string","enum":["required","none"],"description":"Review mode: `required` gates on a professional decision, `none` is accepted on submit."},"condition":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Condition that enables the item (INT-F04); null is always on."},"dueDate":{"type":"string","nullable":true,"format":"date-time","description":"Absolute item due date, or null to inherit the flow."},"dueInDays":{"type":"integer","nullable":true,"minimum":0,"maximum":3650,"description":"Or the offset from the send date."},"targetPath":{"type":"string","nullable":true,"maxLength":500,"description":"Template target path (for example \"2 Personal documents\"), created on send when absent."},"fileRules":{"type":"object","nullable":true,"properties":{"minFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Minimum files to submit (default 1)."},"maxFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Maximum files (default 1, max 50)."},"allowedKinds":{"type":"array","items":{"type":"string","enum":["pdf","image","office","email","any"],"description":"Accepted file kind, checked by content at scan (SEC-08)."},"minItems":1,"maxItems":5,"description":"Accepted kinds, checked by content at scan (SEC-08); `any` covers the rest."},"maxFileBytes":{"type":"integer","minimum":1,"maximum":5368709120,"description":"Per-file size cap in bytes (default 100 MiB, never above 5 GiB, DOC-16)."},"camera":{"type":"boolean","description":"Offer camera capture for images/PDF (HYP-02)."}},"additionalProperties":false,"description":"Present for `file` items."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":20000,"description":"`text`: maximum length in characters (default 2000)."},"min":{"type":"number","nullable":true,"description":"`number`: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"`number`: inclusive maximum."},"decimals":{"type":"integer","nullable":true,"minimum":0,"maximum":6,"description":"`number`: allowed decimals."},"unit":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"`number`: unit label (for example \"years\")."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false,"description":"Choice option of a `choice` item."},"maxItems":50,"description":"`choice`: the options."},"multiple":{"type":"boolean","description":"`choice`: allow more than one option."}},"additionalProperties":false,"description":"Present for answer items."},"group":{"type":"object","nullable":true,"properties":{"groupId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Group id within the template (E20 `required: \"group\"`)."},"satisfiedBy":{"type":"string","enum":["any_of"],"description":"Only `any_of` in the MVP: one approved option satisfies the group."},"option":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Option code of this item within the group."}},"required":["groupId","satisfiedBy","option"],"additionalProperties":false,"description":"E20 alternative group (INT-F06)."},"documentType":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"DOC-11 / E20 document type id."},"validity":{"type":"object","nullable":true,"properties":{"rule":{"type":"string","enum":["none","max_age","not_expired","covers_years"],"description":"E20 validity rule (HYP-06)."},"months":{"type":"integer","nullable":true,"minimum":0,"maximum":600,"description":"Age or cover window in months."}},"required":["rule","months"],"additionalProperties":false,"description":"E20 validity rule (HYP-06)."},"retentionClass":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"E20 / ADR-0012 retention class id."},"bsnSensitive":{"type":"boolean","description":"Document carries a BSN (HYP-07)."},"idPhotoMustStayVisible":{"type":"boolean","description":"ID photo must stay visible when BSN is masked (HYP-07)."},"stage":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"E20 stage id used for ordering and deadline risk (HYP-05)."}},"required":["sectionId","position","type","title","instructions","required","allowNotApplicable","assignees","visibility","review","condition","dueDate","dueInDays","targetPath","fileRules","answerRules","group","documentType","validity","retentionClass","bsnSensitive","idPhotoMustStayVisible","stage"],"additionalProperties":false,"description":"Item definition of a template version or flow draft (INT-F05, INT-F06)."},"maxItems":1000,"description":"Items of the request (INT-F05)."},"reminderPolicy":{"type":"object","properties":{"offsetsInDays":{"type":"array","items":{"type":"integer","minimum":1,"maximum":365},"maxItems":20,"description":"Days after send to remind open items; ascending and deduplicated."},"maxReminders":{"type":"integer","minimum":0,"maximum":20,"description":"Upper bound of reminders per flow."}},"required":["offsetsInDays","maxReminders"],"additionalProperties":false,"description":"Reminders of the request (INT-F19)."},"reasonExtensions":{"type":"object","properties":{"rerequest":{"type":"array","items":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"maxItems":50,"description":"Extra re-request codes accepted on items of this template (E20 `item_rerequest`)."},"waive":{"type":"array","items":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"maxItems":50,"description":"Extra waive codes accepted on items of this template (E20 `item_waiver`)."}},"additionalProperties":false,"description":"Template reason extensions (INT-F16)."}},"required":["conditions","sections","items","reminderPolicy","reasonExtensions"],"additionalProperties":false,"description":"Immutable content of a template version (INT-F02)."},"copiedFrom":{"type":"object","nullable":true,"properties":{"templateId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":1}},"required":["templateId","versionNo"],"description":"Copied-from reference (INT-F01)."},"createdAt":{"type":"string","format":"date-time"},"publishedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","templateId","versionNo","state","content","copiedFrom","createdAt","publishedAt"],"description":"Current draft version, or null when none exists."},"latestPublished":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"templateId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":1},"state":{"type":"string","enum":["draft","published"],"description":"Template version state (INT-F02)."},"content":{"type":"object","properties":{"conditions":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"help":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional help text for the builder."},"defaultValue":{"type":"boolean","description":"Initial value in the builder."}},"required":["code","label","help","defaultValue"],"additionalProperties":false,"description":"Template condition (INT-F04)."},"maxItems":50,"description":"Conditions (INT-F04)."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Stable section id (absent on a fresh draft)."},"parentSectionId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section; a child of a child is refused (`SECTION_DEPTH`, INT-F04)."},"position":{"type":"integer","minimum":0,"description":"Order among its siblings."},"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional instructions above the items."},"defaultTargetPath":{"type":"string","nullable":true,"maxLength":500,"description":"Default target folder for the section."}},"required":["parentSectionId","position","title","instructions","defaultTargetPath"],"additionalProperties":false,"description":"Section of a template version or flow draft (INT-F04)."},"maxItems":200,"description":"Sections, one nesting level (INT-F04)."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Stable item id (absent on a fresh draft)."},"sectionId":{"type":"string","format":"uuid","description":"Section the item belongs to."},"position":{"type":"integer","minimum":0,"description":"Order within the section."},"type":{"type":"string","enum":["file","text","number","date","choice","acknowledgement","instructions"],"description":"Item type (INT-F05)."},"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional instructions shown with the item."},"required":{"type":"boolean","description":"Optional items never block completion (INT-F06)."},"allowNotApplicable":{"type":"boolean","description":"Offer \"Not applicable\" (default true for optional, false for required file items)."},"assignees":{"type":"array","items":{"type":"string","pattern":"^(client|all_recipients|organisation|applicant_[1-9][0-9]?)$","description":"Assignee slot: client, all_recipients, organisation or applicant_<n>."},"minItems":1,"maxItems":20,"description":"Slots that provide the item; `organisation` for firm-owned items."},"visibility":{"type":"string","enum":["assignees","internal","shared_on_approval"],"description":"Item visibility (INT-F06, INT-F07)."},"review":{"type":"string","enum":["required","none"],"description":"Review mode: `required` gates on a professional decision, `none` is accepted on submit."},"condition":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Condition that enables the item (INT-F04); null is always on."},"dueDate":{"type":"string","nullable":true,"format":"date-time","description":"Absolute item due date, or null to inherit the flow."},"dueInDays":{"type":"integer","nullable":true,"minimum":0,"maximum":3650,"description":"Or the offset from the send date."},"targetPath":{"type":"string","nullable":true,"maxLength":500,"description":"Template target path (for example \"2 Personal documents\"), created on send when absent."},"fileRules":{"type":"object","nullable":true,"properties":{"minFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Minimum files to submit (default 1)."},"maxFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Maximum files (default 1, max 50)."},"allowedKinds":{"type":"array","items":{"type":"string","enum":["pdf","image","office","email","any"],"description":"Accepted file kind, checked by content at scan (SEC-08)."},"minItems":1,"maxItems":5,"description":"Accepted kinds, checked by content at scan (SEC-08); `any` covers the rest."},"maxFileBytes":{"type":"integer","minimum":1,"maximum":5368709120,"description":"Per-file size cap in bytes (default 100 MiB, never above 5 GiB, DOC-16)."},"camera":{"type":"boolean","description":"Offer camera capture for images/PDF (HYP-02)."}},"additionalProperties":false,"description":"Present for `file` items."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":20000,"description":"`text`: maximum length in characters (default 2000)."},"min":{"type":"number","nullable":true,"description":"`number`: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"`number`: inclusive maximum."},"decimals":{"type":"integer","nullable":true,"minimum":0,"maximum":6,"description":"`number`: allowed decimals."},"unit":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"`number`: unit label (for example \"years\")."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false,"description":"Choice option of a `choice` item."},"maxItems":50,"description":"`choice`: the options."},"multiple":{"type":"boolean","description":"`choice`: allow more than one option."}},"additionalProperties":false,"description":"Present for answer items."},"group":{"type":"object","nullable":true,"properties":{"groupId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Group id within the template (E20 `required: \"group\"`)."},"satisfiedBy":{"type":"string","enum":["any_of"],"description":"Only `any_of` in the MVP: one approved option satisfies the group."},"option":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Option code of this item within the group."}},"required":["groupId","satisfiedBy","option"],"additionalProperties":false,"description":"E20 alternative group (INT-F06)."},"documentType":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"DOC-11 / E20 document type id."},"validity":{"type":"object","nullable":true,"properties":{"rule":{"type":"string","enum":["none","max_age","not_expired","covers_years"],"description":"E20 validity rule (HYP-06)."},"months":{"type":"integer","nullable":true,"minimum":0,"maximum":600,"description":"Age or cover window in months."}},"required":["rule","months"],"additionalProperties":false,"description":"E20 validity rule (HYP-06)."},"retentionClass":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"E20 / ADR-0012 retention class id."},"bsnSensitive":{"type":"boolean","description":"Document carries a BSN (HYP-07)."},"idPhotoMustStayVisible":{"type":"boolean","description":"ID photo must stay visible when BSN is masked (HYP-07)."},"stage":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"E20 stage id used for ordering and deadline risk (HYP-05)."}},"required":["sectionId","position","type","title","instructions","required","allowNotApplicable","assignees","visibility","review","condition","dueDate","dueInDays","targetPath","fileRules","answerRules","group","documentType","validity","retentionClass","bsnSensitive","idPhotoMustStayVisible","stage"],"additionalProperties":false,"description":"Item definition of a template version or flow draft (INT-F05, INT-F06)."},"maxItems":1000,"description":"Items of the request (INT-F05)."},"reminderPolicy":{"type":"object","properties":{"offsetsInDays":{"type":"array","items":{"type":"integer","minimum":1,"maximum":365},"maxItems":20,"description":"Days after send to remind open items; ascending and deduplicated."},"maxReminders":{"type":"integer","minimum":0,"maximum":20,"description":"Upper bound of reminders per flow."}},"required":["offsetsInDays","maxReminders"],"additionalProperties":false,"description":"Reminders of the request (INT-F19)."},"reasonExtensions":{"type":"object","properties":{"rerequest":{"type":"array","items":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"maxItems":50,"description":"Extra re-request codes accepted on items of this template (E20 `item_rerequest`)."},"waive":{"type":"array","items":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"maxItems":50,"description":"Extra waive codes accepted on items of this template (E20 `item_waiver`)."}},"additionalProperties":false,"description":"Template reason extensions (INT-F16)."}},"required":["conditions","sections","items","reminderPolicy","reasonExtensions"],"additionalProperties":false,"description":"Immutable content of a template version (INT-F02)."},"copiedFrom":{"type":"object","nullable":true,"properties":{"templateId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":1}},"required":["templateId","versionNo"],"description":"Copied-from reference (INT-F01)."},"createdAt":{"type":"string","format":"date-time"},"publishedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","templateId","versionNo","state","content","copiedFrom","createdAt","publishedAt"],"description":"Latest published version, or null when never published."}},"required":["template","draft","latestPublished"],"description":"Template detail with its draft and latest published version (INT-F01, INT-F02)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or template.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/flow-templates/{templateId}/draft":{"put":{"operationId":"saveFlowTemplateDraft","summary":"Save the template draft","description":"Replaces the one draft (INT-F02). Validation answers 422 with a code from the flow vocabulary (SECTION_DEPTH, ITEM_TYPE_INVALID, FILE_RULES_INVALID, HEALTH_DOCUMENT_TYPE_FORBIDDEN, HEALTH_KEYWORD_FORBIDDEN, REASON_EXTENSION_INVALID). Draft edits are unaudited; publishing is audited.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"templateId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200,"description":"New template name."},"content":{"type":"object","properties":{"conditions":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"help":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional help text for the builder."},"defaultValue":{"type":"boolean","description":"Initial value in the builder."}},"required":["code","label","help","defaultValue"],"additionalProperties":false,"description":"Template condition (INT-F04)."},"maxItems":50,"description":"Conditions (INT-F04)."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Stable section id (absent on a fresh draft)."},"parentSectionId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section; a child of a child is refused (`SECTION_DEPTH`, INT-F04)."},"position":{"type":"integer","minimum":0,"description":"Order among its siblings."},"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional instructions above the items."},"defaultTargetPath":{"type":"string","nullable":true,"maxLength":500,"description":"Default target folder for the section."}},"required":["parentSectionId","position","title","instructions","defaultTargetPath"],"additionalProperties":false,"description":"Section of a template version or flow draft (INT-F04)."},"maxItems":200,"description":"Sections, one nesting level (INT-F04)."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Stable item id (absent on a fresh draft)."},"sectionId":{"type":"string","format":"uuid","description":"Section the item belongs to."},"position":{"type":"integer","minimum":0,"description":"Order within the section."},"type":{"type":"string","enum":["file","text","number","date","choice","acknowledgement","instructions"],"description":"Item type (INT-F05)."},"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional instructions shown with the item."},"required":{"type":"boolean","description":"Optional items never block completion (INT-F06)."},"allowNotApplicable":{"type":"boolean","description":"Offer \"Not applicable\" (default true for optional, false for required file items)."},"assignees":{"type":"array","items":{"type":"string","pattern":"^(client|all_recipients|organisation|applicant_[1-9][0-9]?)$","description":"Assignee slot: client, all_recipients, organisation or applicant_<n>."},"minItems":1,"maxItems":20,"description":"Slots that provide the item; `organisation` for firm-owned items."},"visibility":{"type":"string","enum":["assignees","internal","shared_on_approval"],"description":"Item visibility (INT-F06, INT-F07)."},"review":{"type":"string","enum":["required","none"],"description":"Review mode: `required` gates on a professional decision, `none` is accepted on submit."},"condition":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Condition that enables the item (INT-F04); null is always on."},"dueDate":{"type":"string","nullable":true,"format":"date-time","description":"Absolute item due date, or null to inherit the flow."},"dueInDays":{"type":"integer","nullable":true,"minimum":0,"maximum":3650,"description":"Or the offset from the send date."},"targetPath":{"type":"string","nullable":true,"maxLength":500,"description":"Template target path (for example \"2 Personal documents\"), created on send when absent."},"fileRules":{"type":"object","nullable":true,"properties":{"minFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Minimum files to submit (default 1)."},"maxFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Maximum files (default 1, max 50)."},"allowedKinds":{"type":"array","items":{"type":"string","enum":["pdf","image","office","email","any"],"description":"Accepted file kind, checked by content at scan (SEC-08)."},"minItems":1,"maxItems":5,"description":"Accepted kinds, checked by content at scan (SEC-08); `any` covers the rest."},"maxFileBytes":{"type":"integer","minimum":1,"maximum":5368709120,"description":"Per-file size cap in bytes (default 100 MiB, never above 5 GiB, DOC-16)."},"camera":{"type":"boolean","description":"Offer camera capture for images/PDF (HYP-02)."}},"additionalProperties":false,"description":"Present for `file` items."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":20000,"description":"`text`: maximum length in characters (default 2000)."},"min":{"type":"number","nullable":true,"description":"`number`: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"`number`: inclusive maximum."},"decimals":{"type":"integer","nullable":true,"minimum":0,"maximum":6,"description":"`number`: allowed decimals."},"unit":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"`number`: unit label (for example \"years\")."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false,"description":"Choice option of a `choice` item."},"maxItems":50,"description":"`choice`: the options."},"multiple":{"type":"boolean","description":"`choice`: allow more than one option."}},"additionalProperties":false,"description":"Present for answer items."},"group":{"type":"object","nullable":true,"properties":{"groupId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Group id within the template (E20 `required: \"group\"`)."},"satisfiedBy":{"type":"string","enum":["any_of"],"description":"Only `any_of` in the MVP: one approved option satisfies the group."},"option":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Option code of this item within the group."}},"required":["groupId","satisfiedBy","option"],"additionalProperties":false,"description":"E20 alternative group (INT-F06)."},"documentType":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"DOC-11 / E20 document type id."},"validity":{"type":"object","nullable":true,"properties":{"rule":{"type":"string","enum":["none","max_age","not_expired","covers_years"],"description":"E20 validity rule (HYP-06)."},"months":{"type":"integer","nullable":true,"minimum":0,"maximum":600,"description":"Age or cover window in months."}},"required":["rule","months"],"additionalProperties":false,"description":"E20 validity rule (HYP-06)."},"retentionClass":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"E20 / ADR-0012 retention class id."},"bsnSensitive":{"type":"boolean","description":"Document carries a BSN (HYP-07)."},"idPhotoMustStayVisible":{"type":"boolean","description":"ID photo must stay visible when BSN is masked (HYP-07)."},"stage":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"E20 stage id used for ordering and deadline risk (HYP-05)."}},"required":["sectionId","position","type","title","instructions","required","allowNotApplicable","assignees","visibility","review","condition","dueDate","dueInDays","targetPath","fileRules","answerRules","group","documentType","validity","retentionClass","bsnSensitive","idPhotoMustStayVisible","stage"],"additionalProperties":false,"description":"Item definition of a template version or flow draft (INT-F05, INT-F06)."},"maxItems":1000,"description":"Items of the request (INT-F05)."},"reminderPolicy":{"type":"object","properties":{"offsetsInDays":{"type":"array","items":{"type":"integer","minimum":1,"maximum":365},"maxItems":20,"description":"Days after send to remind open items; ascending and deduplicated."},"maxReminders":{"type":"integer","minimum":0,"maximum":20,"description":"Upper bound of reminders per flow."}},"required":["offsetsInDays","maxReminders"],"additionalProperties":false,"description":"Reminders of the request (INT-F19)."},"reasonExtensions":{"type":"object","properties":{"rerequest":{"type":"array","items":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"maxItems":50,"description":"Extra re-request codes accepted on items of this template (E20 `item_rerequest`)."},"waive":{"type":"array","items":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"maxItems":50,"description":"Extra waive codes accepted on items of this template (E20 `item_waiver`)."}},"additionalProperties":false,"description":"Template reason extensions (INT-F16)."}},"required":["conditions","sections","items","reminderPolicy","reasonExtensions"],"additionalProperties":false,"description":"Draft content; publishing freezes it as the next version."}},"required":["content"],"additionalProperties":false,"description":"Save the template draft (INT-F02)."}}}},"responses":{"200":{"description":"Stored draft.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"templateId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":1},"state":{"type":"string","enum":["draft","published"],"description":"Template version state (INT-F02)."},"content":{"type":"object","properties":{"conditions":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"help":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional help text for the builder."},"defaultValue":{"type":"boolean","description":"Initial value in the builder."}},"required":["code","label","help","defaultValue"],"additionalProperties":false,"description":"Template condition (INT-F04)."},"maxItems":50,"description":"Conditions (INT-F04)."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Stable section id (absent on a fresh draft)."},"parentSectionId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section; a child of a child is refused (`SECTION_DEPTH`, INT-F04)."},"position":{"type":"integer","minimum":0,"description":"Order among its siblings."},"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional instructions above the items."},"defaultTargetPath":{"type":"string","nullable":true,"maxLength":500,"description":"Default target folder for the section."}},"required":["parentSectionId","position","title","instructions","defaultTargetPath"],"additionalProperties":false,"description":"Section of a template version or flow draft (INT-F04)."},"maxItems":200,"description":"Sections, one nesting level (INT-F04)."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Stable item id (absent on a fresh draft)."},"sectionId":{"type":"string","format":"uuid","description":"Section the item belongs to."},"position":{"type":"integer","minimum":0,"description":"Order within the section."},"type":{"type":"string","enum":["file","text","number","date","choice","acknowledgement","instructions"],"description":"Item type (INT-F05)."},"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional instructions shown with the item."},"required":{"type":"boolean","description":"Optional items never block completion (INT-F06)."},"allowNotApplicable":{"type":"boolean","description":"Offer \"Not applicable\" (default true for optional, false for required file items)."},"assignees":{"type":"array","items":{"type":"string","pattern":"^(client|all_recipients|organisation|applicant_[1-9][0-9]?)$","description":"Assignee slot: client, all_recipients, organisation or applicant_<n>."},"minItems":1,"maxItems":20,"description":"Slots that provide the item; `organisation` for firm-owned items."},"visibility":{"type":"string","enum":["assignees","internal","shared_on_approval"],"description":"Item visibility (INT-F06, INT-F07)."},"review":{"type":"string","enum":["required","none"],"description":"Review mode: `required` gates on a professional decision, `none` is accepted on submit."},"condition":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Condition that enables the item (INT-F04); null is always on."},"dueDate":{"type":"string","nullable":true,"format":"date-time","description":"Absolute item due date, or null to inherit the flow."},"dueInDays":{"type":"integer","nullable":true,"minimum":0,"maximum":3650,"description":"Or the offset from the send date."},"targetPath":{"type":"string","nullable":true,"maxLength":500,"description":"Template target path (for example \"2 Personal documents\"), created on send when absent."},"fileRules":{"type":"object","nullable":true,"properties":{"minFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Minimum files to submit (default 1)."},"maxFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Maximum files (default 1, max 50)."},"allowedKinds":{"type":"array","items":{"type":"string","enum":["pdf","image","office","email","any"],"description":"Accepted file kind, checked by content at scan (SEC-08)."},"minItems":1,"maxItems":5,"description":"Accepted kinds, checked by content at scan (SEC-08); `any` covers the rest."},"maxFileBytes":{"type":"integer","minimum":1,"maximum":5368709120,"description":"Per-file size cap in bytes (default 100 MiB, never above 5 GiB, DOC-16)."},"camera":{"type":"boolean","description":"Offer camera capture for images/PDF (HYP-02)."}},"additionalProperties":false,"description":"Present for `file` items."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":20000,"description":"`text`: maximum length in characters (default 2000)."},"min":{"type":"number","nullable":true,"description":"`number`: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"`number`: inclusive maximum."},"decimals":{"type":"integer","nullable":true,"minimum":0,"maximum":6,"description":"`number`: allowed decimals."},"unit":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"`number`: unit label (for example \"years\")."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false,"description":"Choice option of a `choice` item."},"maxItems":50,"description":"`choice`: the options."},"multiple":{"type":"boolean","description":"`choice`: allow more than one option."}},"additionalProperties":false,"description":"Present for answer items."},"group":{"type":"object","nullable":true,"properties":{"groupId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Group id within the template (E20 `required: \"group\"`)."},"satisfiedBy":{"type":"string","enum":["any_of"],"description":"Only `any_of` in the MVP: one approved option satisfies the group."},"option":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Option code of this item within the group."}},"required":["groupId","satisfiedBy","option"],"additionalProperties":false,"description":"E20 alternative group (INT-F06)."},"documentType":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"DOC-11 / E20 document type id."},"validity":{"type":"object","nullable":true,"properties":{"rule":{"type":"string","enum":["none","max_age","not_expired","covers_years"],"description":"E20 validity rule (HYP-06)."},"months":{"type":"integer","nullable":true,"minimum":0,"maximum":600,"description":"Age or cover window in months."}},"required":["rule","months"],"additionalProperties":false,"description":"E20 validity rule (HYP-06)."},"retentionClass":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"E20 / ADR-0012 retention class id."},"bsnSensitive":{"type":"boolean","description":"Document carries a BSN (HYP-07)."},"idPhotoMustStayVisible":{"type":"boolean","description":"ID photo must stay visible when BSN is masked (HYP-07)."},"stage":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"E20 stage id used for ordering and deadline risk (HYP-05)."}},"required":["sectionId","position","type","title","instructions","required","allowNotApplicable","assignees","visibility","review","condition","dueDate","dueInDays","targetPath","fileRules","answerRules","group","documentType","validity","retentionClass","bsnSensitive","idPhotoMustStayVisible","stage"],"additionalProperties":false,"description":"Item definition of a template version or flow draft (INT-F05, INT-F06)."},"maxItems":1000,"description":"Items of the request (INT-F05)."},"reminderPolicy":{"type":"object","properties":{"offsetsInDays":{"type":"array","items":{"type":"integer","minimum":1,"maximum":365},"maxItems":20,"description":"Days after send to remind open items; ascending and deduplicated."},"maxReminders":{"type":"integer","minimum":0,"maximum":20,"description":"Upper bound of reminders per flow."}},"required":["offsetsInDays","maxReminders"],"additionalProperties":false,"description":"Reminders of the request (INT-F19)."},"reasonExtensions":{"type":"object","properties":{"rerequest":{"type":"array","items":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"maxItems":50,"description":"Extra re-request codes accepted on items of this template (E20 `item_rerequest`)."},"waive":{"type":"array","items":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"maxItems":50,"description":"Extra waive codes accepted on items of this template (E20 `item_waiver`)."}},"additionalProperties":false,"description":"Template reason extensions (INT-F16)."}},"required":["conditions","sections","items","reminderPolicy","reasonExtensions"],"additionalProperties":false,"description":"Immutable content of a template version (INT-F02)."},"copiedFrom":{"type":"object","nullable":true,"properties":{"templateId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":1}},"required":["templateId","versionNo"],"description":"Copied-from reference (INT-F01)."},"createdAt":{"type":"string","format":"date-time"},"publishedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","templateId","versionNo","state","content","copiedFrom","createdAt","publishedAt"],"description":"Template version (INT-F02)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no manage permission).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or template.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"422":{"description":"Template content refused (validation code in the error message).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/flow-templates/{templateId}/publish":{"post":{"operationId":"publishFlowTemplateVersion","summary":"Publish the template draft as a new immutable version","description":"Freezes the draft as version n+1; running flows keep the version they snapshotted (INT-F02). Requires flow_template.manage. Writes flow_template.version_published.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"templateId","in":"path"}],"responses":{"200":{"description":"Published version.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"templateId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":1},"state":{"type":"string","enum":["draft","published"],"description":"Template version state (INT-F02)."},"content":{"type":"object","properties":{"conditions":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"help":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional help text for the builder."},"defaultValue":{"type":"boolean","description":"Initial value in the builder."}},"required":["code","label","help","defaultValue"],"additionalProperties":false,"description":"Template condition (INT-F04)."},"maxItems":50,"description":"Conditions (INT-F04)."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Stable section id (absent on a fresh draft)."},"parentSectionId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section; a child of a child is refused (`SECTION_DEPTH`, INT-F04)."},"position":{"type":"integer","minimum":0,"description":"Order among its siblings."},"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional instructions above the items."},"defaultTargetPath":{"type":"string","nullable":true,"maxLength":500,"description":"Default target folder for the section."}},"required":["parentSectionId","position","title","instructions","defaultTargetPath"],"additionalProperties":false,"description":"Section of a template version or flow draft (INT-F04)."},"maxItems":200,"description":"Sections, one nesting level (INT-F04)."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Stable item id (absent on a fresh draft)."},"sectionId":{"type":"string","format":"uuid","description":"Section the item belongs to."},"position":{"type":"integer","minimum":0,"description":"Order within the section."},"type":{"type":"string","enum":["file","text","number","date","choice","acknowledgement","instructions"],"description":"Item type (INT-F05)."},"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional instructions shown with the item."},"required":{"type":"boolean","description":"Optional items never block completion (INT-F06)."},"allowNotApplicable":{"type":"boolean","description":"Offer \"Not applicable\" (default true for optional, false for required file items)."},"assignees":{"type":"array","items":{"type":"string","pattern":"^(client|all_recipients|organisation|applicant_[1-9][0-9]?)$","description":"Assignee slot: client, all_recipients, organisation or applicant_<n>."},"minItems":1,"maxItems":20,"description":"Slots that provide the item; `organisation` for firm-owned items."},"visibility":{"type":"string","enum":["assignees","internal","shared_on_approval"],"description":"Item visibility (INT-F06, INT-F07)."},"review":{"type":"string","enum":["required","none"],"description":"Review mode: `required` gates on a professional decision, `none` is accepted on submit."},"condition":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Condition that enables the item (INT-F04); null is always on."},"dueDate":{"type":"string","nullable":true,"format":"date-time","description":"Absolute item due date, or null to inherit the flow."},"dueInDays":{"type":"integer","nullable":true,"minimum":0,"maximum":3650,"description":"Or the offset from the send date."},"targetPath":{"type":"string","nullable":true,"maxLength":500,"description":"Template target path (for example \"2 Personal documents\"), created on send when absent."},"fileRules":{"type":"object","nullable":true,"properties":{"minFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Minimum files to submit (default 1)."},"maxFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Maximum files (default 1, max 50)."},"allowedKinds":{"type":"array","items":{"type":"string","enum":["pdf","image","office","email","any"],"description":"Accepted file kind, checked by content at scan (SEC-08)."},"minItems":1,"maxItems":5,"description":"Accepted kinds, checked by content at scan (SEC-08); `any` covers the rest."},"maxFileBytes":{"type":"integer","minimum":1,"maximum":5368709120,"description":"Per-file size cap in bytes (default 100 MiB, never above 5 GiB, DOC-16)."},"camera":{"type":"boolean","description":"Offer camera capture for images/PDF (HYP-02)."}},"additionalProperties":false,"description":"Present for `file` items."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":20000,"description":"`text`: maximum length in characters (default 2000)."},"min":{"type":"number","nullable":true,"description":"`number`: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"`number`: inclusive maximum."},"decimals":{"type":"integer","nullable":true,"minimum":0,"maximum":6,"description":"`number`: allowed decimals."},"unit":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"`number`: unit label (for example \"years\")."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false,"description":"Choice option of a `choice` item."},"maxItems":50,"description":"`choice`: the options."},"multiple":{"type":"boolean","description":"`choice`: allow more than one option."}},"additionalProperties":false,"description":"Present for answer items."},"group":{"type":"object","nullable":true,"properties":{"groupId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Group id within the template (E20 `required: \"group\"`)."},"satisfiedBy":{"type":"string","enum":["any_of"],"description":"Only `any_of` in the MVP: one approved option satisfies the group."},"option":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Option code of this item within the group."}},"required":["groupId","satisfiedBy","option"],"additionalProperties":false,"description":"E20 alternative group (INT-F06)."},"documentType":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"DOC-11 / E20 document type id."},"validity":{"type":"object","nullable":true,"properties":{"rule":{"type":"string","enum":["none","max_age","not_expired","covers_years"],"description":"E20 validity rule (HYP-06)."},"months":{"type":"integer","nullable":true,"minimum":0,"maximum":600,"description":"Age or cover window in months."}},"required":["rule","months"],"additionalProperties":false,"description":"E20 validity rule (HYP-06)."},"retentionClass":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"E20 / ADR-0012 retention class id."},"bsnSensitive":{"type":"boolean","description":"Document carries a BSN (HYP-07)."},"idPhotoMustStayVisible":{"type":"boolean","description":"ID photo must stay visible when BSN is masked (HYP-07)."},"stage":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"E20 stage id used for ordering and deadline risk (HYP-05)."}},"required":["sectionId","position","type","title","instructions","required","allowNotApplicable","assignees","visibility","review","condition","dueDate","dueInDays","targetPath","fileRules","answerRules","group","documentType","validity","retentionClass","bsnSensitive","idPhotoMustStayVisible","stage"],"additionalProperties":false,"description":"Item definition of a template version or flow draft (INT-F05, INT-F06)."},"maxItems":1000,"description":"Items of the request (INT-F05)."},"reminderPolicy":{"type":"object","properties":{"offsetsInDays":{"type":"array","items":{"type":"integer","minimum":1,"maximum":365},"maxItems":20,"description":"Days after send to remind open items; ascending and deduplicated."},"maxReminders":{"type":"integer","minimum":0,"maximum":20,"description":"Upper bound of reminders per flow."}},"required":["offsetsInDays","maxReminders"],"additionalProperties":false,"description":"Reminders of the request (INT-F19)."},"reasonExtensions":{"type":"object","properties":{"rerequest":{"type":"array","items":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"maxItems":50,"description":"Extra re-request codes accepted on items of this template (E20 `item_rerequest`)."},"waive":{"type":"array","items":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"maxItems":50,"description":"Extra waive codes accepted on items of this template (E20 `item_waiver`)."}},"additionalProperties":false,"description":"Template reason extensions (INT-F16)."}},"required":["conditions","sections","items","reminderPolicy","reasonExtensions"],"additionalProperties":false,"description":"Immutable content of a template version (INT-F02)."},"copiedFrom":{"type":"object","nullable":true,"properties":{"templateId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":1}},"required":["templateId","versionNo"],"description":"Copied-from reference (INT-F01)."},"createdAt":{"type":"string","format":"date-time"},"publishedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","templateId","versionNo","state","content","copiedFrom","createdAt","publishedAt"],"description":"Template version (INT-F02)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no manage permission).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or template.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"No draft to publish.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"422":{"description":"Draft content refused (validation code in the error message).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/flow-templates/{templateId}/copy":{"post":{"operationId":"copyFlowTemplate","summary":"Copy a template into the organisation","description":"Copies a system starter or another organisation template as a new editable template, recording `copied_from` (INT-F01). The source stays unchanged. Requires flow_template.manage. Writes flow_template.copied.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"templateId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200,"description":"Name of the copy."},"versionNo":{"type":"integer","minimum":1,"description":"Version to copy; defaults to the latest published."}},"required":["name"],"additionalProperties":false,"description":"Copy a template into the organisation (INT-F01)."}}}},"responses":{"201":{"description":"Created copy.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"tenantId":{"type":"string","format":"uuid"},"name":{"type":"string"},"state":{"type":"string","enum":["active","archived"],"description":"Template lifecycle state."},"latestPublishedVersionNo":{"type":"integer","nullable":true,"minimum":1},"draftVersionNo":{"type":"integer","nullable":true,"minimum":1},"copiedFrom":{"type":"object","nullable":true,"properties":{"templateId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":1}},"required":["templateId","versionNo"],"description":"Set on organisation copies of a starter template (INT-F01)."},"isSystemTemplate":{"type":"boolean","description":"True for read-only system starters (tenant_id NULL)."},"newerSystemVersionAvailable":{"type":"boolean","description":"A newer system version exists; the copy does not change by itself (INT-F01)."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","tenantId","name","state","latestPublishedVersionNo","draftVersionNo","copiedFrom","isSystemTemplate","newerSystemVersionAvailable","createdAt","updatedAt"],"description":"Organisation flow template (INT-F01)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no manage permission).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or source version.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/flow-templates/{templateId}/archive":{"post":{"operationId":"archiveFlowTemplate","summary":"Archive a template","description":"Hides the template from \"New request\"; its versions stay readable by existing flows (INT-F01). Requires flow_template.manage. Writes flow_template.archived.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"templateId","in":"path"}],"responses":{"200":{"description":"Archived template.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"tenantId":{"type":"string","format":"uuid"},"name":{"type":"string"},"state":{"type":"string","enum":["active","archived"],"description":"Template lifecycle state."},"latestPublishedVersionNo":{"type":"integer","nullable":true,"minimum":1},"draftVersionNo":{"type":"integer","nullable":true,"minimum":1},"copiedFrom":{"type":"object","nullable":true,"properties":{"templateId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":1}},"required":["templateId","versionNo"],"description":"Set on organisation copies of a starter template (INT-F01)."},"isSystemTemplate":{"type":"boolean","description":"True for read-only system starters (tenant_id NULL)."},"newerSystemVersionAvailable":{"type":"boolean","description":"A newer system version exists; the copy does not change by itself (INT-F01)."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","tenantId","name","state","latestPublishedVersionNo","draftVersionNo","copiedFrom","isSystemTemplate","newerSystemVersionAvailable","createdAt","updatedAt"],"description":"Organisation flow template (INT-F01)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no manage permission).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or template.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/flow-templates/{templateId}/restore":{"post":{"operationId":"restoreFlowTemplate","summary":"Restore an archived template","description":"Brings an archived template back into \"New request\" (INT-F01). Requires flow_template.manage. Writes flow_template.restored.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"templateId","in":"path"}],"responses":{"200":{"description":"Restored template.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"tenantId":{"type":"string","format":"uuid"},"name":{"type":"string"},"state":{"type":"string","enum":["active","archived"],"description":"Template lifecycle state."},"latestPublishedVersionNo":{"type":"integer","nullable":true,"minimum":1},"draftVersionNo":{"type":"integer","nullable":true,"minimum":1},"copiedFrom":{"type":"object","nullable":true,"properties":{"templateId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":1}},"required":["templateId","versionNo"],"description":"Set on organisation copies of a starter template (INT-F01)."},"isSystemTemplate":{"type":"boolean","description":"True for read-only system starters (tenant_id NULL)."},"newerSystemVersionAvailable":{"type":"boolean","description":"A newer system version exists; the copy does not change by itself (INT-F01)."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","tenantId","name","state","latestPublishedVersionNo","draftVersionNo","copiedFrom","isSystemTemplate","newerSystemVersionAvailable","createdAt","updatedAt"],"description":"Organisation flow template (INT-F01)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no manage permission).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or template.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/flows":{"get":{"operationId":"listFlows","summary":"List the flows of a room","description":"Flows the principal may see in one room, as a draft (firm only) or sent/complete/closed (INT-F03, INT-F07). Requires room access; 404 without it. Navigation read: no audit event.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"Flows.","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"flows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"tenantId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"templateVersionId":{"type":"string","nullable":true,"format":"uuid","description":"Frozen template version (null for a blank request)."},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"title":{"type":"string"},"message":{"type":"string","nullable":true,"description":"Message to the client; shown in the portal."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipients":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^(client|all_recipients|organisation|applicant_[1-9][0-9]?)$","description":"Assignee slot: client, all_recipients, organisation or applicant_<n>."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group bound to the slot; null for `organisation`."},"groupLabel":{"type":"string","nullable":true,"description":"Display label of the group (slot label in the review queue)."}},"required":["slot","groupId","groupLabel"],"description":"Slot → room group binding of a flow (INT-F03)."}},"conditionValues":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"enabled":{"type":"boolean"}},"required":["code","enabled"],"description":"Condition state of a flow (INT-F04)."}},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"],"description":"Portal counters."},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"],"description":"Firm counters."},"sections":{"type":"array","items":{"type":"object","properties":{"sectionId":{"type":"string","format":"uuid"},"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["sectionId","done","total"],"description":"Per-section counters (INT-F18)."},"description":"Counters per visible section."}},"required":["client","firm","sections"],"description":"Progress of a flow for one viewer (INT-F18)."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"parentSectionId":{"type":"string","nullable":true,"format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"itemCount":{"type":"integer","minimum":0}},"required":["id","parentSectionId","position","title","instructions","itemCount"],"description":"Section view (INT-F04)."},"description":"Visible sections, numbered for the viewer."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"flowId":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"type":{"type":"string","enum":["file","text","number","date","choice","acknowledgement","instructions"],"description":"Item type (INT-F05)."},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"status":{"type":"string","enum":["to_do","submitted","in_review","approved","rejected","not_applicable","cancelled"],"description":"Item status (INT-F14)."},"revision":{"type":"integer","minimum":0,"description":"View revision for optimistic concurrency (INT-F14)."},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"assignees":{"type":"array","items":{"type":"string","pattern":"^(client|all_recipients|organisation|applicant_[1-9][0-9]?)$","description":"Assignee slot: client, all_recipients, organisation or applicant_<n>."}},"visibility":{"type":"string","enum":["assignees","internal","shared_on_approval"],"description":"Item visibility (INT-F06, INT-F07)."},"review":{"type":"string","enum":["required","none"],"description":"Review mode: `required` gates on a professional decision, `none` is accepted on submit."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"overdue":{"type":"boolean","description":"Derived: due date passed and status `to_do` or `rejected`."},"skippedAt":{"type":"string","nullable":true,"format":"date-time","description":"Latest skip marker (INT-F12)."},"lastSubmissionKind":{"type":"string","nullable":true,"enum":["files","answer","acknowledgement","not_applicable",null],"description":"Submission kind (INT-F11, INT-F12)."},"submission":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"itemId":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["files","answer","acknowledgement","not_applicable"],"description":"Submission kind (INT-F11, INT-F12)."},"decision":{"type":"string","enum":["pending","approved","rejected","superseded"],"description":"Submission decision (ADR-0013 D2, INT-F16)."},"baseItemRevision":{"type":"integer","minimum":0},"submittedByPrincipalId":{"type":"string","nullable":true,"format":"uuid"},"submittedAt":{"type":"string","format":"date-time"},"authStrength":{"type":"string","enum":["single","mfa"],"description":"Recorded auth strength (ADR-0013 D1)."},"decidedBy":{"type":"string","nullable":true,"format":"uuid"},"decidedAt":{"type":"string","nullable":true,"format":"date-time"},"reasonCode":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Decision reason code; text lives in the encrypted note."},"noteId":{"type":"string","nullable":true,"format":"uuid","description":"Opaque reason-note id; reading it writes `note.read`."},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Document date set at approval (HYP-06)."},"files":{"type":"array","items":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"sha256Hex":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the original (receipt, AUD-09)."},"sizePlain":{"type":"integer","nullable":true,"minimum":0,"description":"Plaintext size in bytes."},"scanState":{"type":"string","enum":["scanning","available","rejected","failed"],"description":"ADR-0007 version status."}},"required":["versionId","documentId","sha256Hex","sizePlain","scanState"],"description":"One file of a submission (no file names)."},"description":"Files of a `files` submission."}},"required":["id","itemId","kind","decision","baseItemRevision","submittedByPrincipalId","submittedAt","authStrength","decidedBy","decidedAt","reasonCode","noteId","documentDate","files"],"description":"Open submission, when the view shows `submitted`."},"fileRules":{"type":"object","nullable":true,"properties":{"minFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Minimum files to submit (default 1)."},"maxFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Maximum files (default 1, max 50)."},"allowedKinds":{"type":"array","items":{"type":"string","enum":["pdf","image","office","email","any"],"description":"Accepted file kind, checked by content at scan (SEC-08)."},"minItems":1,"maxItems":5,"description":"Accepted kinds, checked by content at scan (SEC-08); `any` covers the rest."},"maxFileBytes":{"type":"integer","minimum":1,"maximum":5368709120,"description":"Per-file size cap in bytes (default 100 MiB, never above 5 GiB, DOC-16)."},"camera":{"type":"boolean","description":"Offer camera capture for images/PDF (HYP-02)."}},"additionalProperties":false,"description":"File rules of a `file` item (INT-F06). Omitted fields fall back to `flowFileRulesDefaults`."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":20000,"description":"`text`: maximum length in characters (default 2000)."},"min":{"type":"number","nullable":true,"description":"`number`: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"`number`: inclusive maximum."},"decimals":{"type":"integer","nullable":true,"minimum":0,"maximum":6,"description":"`number`: allowed decimals."},"unit":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"`number`: unit label (for example \"years\")."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false,"description":"Choice option of a `choice` item."},"maxItems":50,"description":"`choice`: the options."},"multiple":{"type":"boolean","description":"`choice`: allow more than one option."}},"additionalProperties":false,"description":"Answer rules of a `text`, `number`, `date` or `choice` item (INT-F05). Omitted fields fall back to `flowAnswerRulesDefaults`."},"group":{"type":"object","nullable":true,"properties":{"groupId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Group id within the template (E20 `required: \"group\"`)."},"satisfiedBy":{"type":"string","enum":["any_of"],"description":"Only `any_of` in the MVP: one approved option satisfies the group."},"option":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Option code of this item within the group."}},"required":["groupId","satisfiedBy","option"],"additionalProperties":false,"description":"Group of alternatives (E20 `required: \"group\"`, INT-F06)."},"documentType":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"validity":{"type":"object","nullable":true,"properties":{"rule":{"type":"string","enum":["none","max_age","not_expired","covers_years"],"description":"E20 validity rule (HYP-06)."},"months":{"type":"integer","nullable":true,"minimum":0,"maximum":600,"description":"Age or cover window in months."}},"required":["rule","months"],"additionalProperties":false,"description":"E20 validity rule (HYP-06)."},"bsnSensitive":{"type":"boolean"},"idPhotoMustStayVisible":{"type":"boolean"}},"required":["id","flowId","sectionId","position","type","title","instructions","status","revision","required","allowNotApplicable","assignees","visibility","review","dueDate","overdue","skippedAt","lastSubmissionKind","submission","fileRules","answerRules","group","documentType","validity","bsnSensitive","idPhotoMustStayVisible"],"description":"Item view computed from firm-written and guest-owned rows (INT-F07a)."},"description":"Visible item views (INT-F07)."},"createdAt":{"type":"string","format":"date-time"},"sentAt":{"type":"string","nullable":true,"format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","tenantId","roomId","templateVersionId","status","title","message","dueDate","recipients","conditionValues","progress","sections","items","createdAt","sentAt","completedAt"],"description":"Flow instance with the viewer-visible sections, items and progress (INT-F03, INT-F18)."}}},"required":["flows"],"description":"Flows of a room the principal may see (INT-F03)."},{"type":"object","properties":{"flows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"templateId":{"type":"string","nullable":true,"maxLength":100},"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipient":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"email":{"type":"string","maxLength":320,"format":"email"}},"required":["name","email"],"description":"The one person a request is addressed to (client data)."},"portalUrl":{"type":"string","nullable":true,"description":"Always null on the real stack: the link token is only ever in the request e-mail."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group bound to the party; null until the firm binds it."}},"required":["slot","label","groupId"],"additionalProperties":false,"description":"Room-bound party of a request (WF01): applicant slot, display label, room group."},"description":"Named room parties of this request (WF01); empty on legacy rows without a scope."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): bound parties share drafts. False keeps slot-private answers."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance. Null on legacy rows without a period."},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."},"targetFolderId":{"type":"string","nullable":true,"format":"uuid","description":"Room-index folder the approved files go into; null = root."},"targetFolderTitle":{"type":"string","nullable":true},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"overdue":{"type":"boolean"},"authStrength":{"type":"string","nullable":true,"enum":["single","mfa",null],"description":"Strength of the client session that submitted the item (ADR-0013 D1 condition 1)."},"bsnAutoMask":{"type":"boolean","description":"The worker burns every BSN out of a delivered file before approval (ADR-0053)."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number","targetFolderId","targetFolderTitle","submittedAt","overdue","authStrength"],"description":"Request item as the firm sees it."}},"createdAt":{"type":"string","format":"date-time"},"sentAt":{"type":"string","nullable":true,"format":"date-time"},"openedAt":{"type":"string","nullable":true,"format":"date-time"},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"reminders":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"description":"Reminders sent so far (automatic and manual)."},"lastAt":{"type":"string","nullable":true,"format":"date-time"},"nextAt":{"type":"string","nullable":true,"format":"date-time","description":"Next automatic reminder; null when none is due."},"paused":{"type":"boolean"}},"required":["count","lastAt","nextAt","paused"],"description":"Reminder state (ADR-0053)."}},"required":["id","roomId","templateId","title","message","status","dueDate","recipient","portalUrl","parties","joint","periodContext","expiresAt","coverInstructions","displayStatus","progress","sections","items","createdAt","sentAt","openedAt","submittedAt","completedAt","updatedAt"],"description":"Document request (request-flow profile, firm view)."}}},"required":["flows"],"description":"Requests of a room (request-flow profile)."}]}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, or no access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"post":{"operationId":"createFlow","summary":"Create a flow draft in a room","description":"Creates a draft from a frozen template version or blank, binding each slot to a distinct external group (SLOT_GROUP_INVALID for internal groups) and switching conditions (INT-F03, INT-F04). Requires manage on the room root; a target that is internal answers TARGET_INTERNAL. A draft is invisible to guests. Writes flow.created.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"templateVersionId":{"type":"string","nullable":true,"format":"uuid","description":"Frozen template version, or null for a blank request."},"title":{"type":"string","minLength":1,"maxLength":200,"description":"Request title (room metadata, never in e-mail subjects)."},"dueDate":{"type":"string","nullable":true,"format":"date-time","description":"Absolute due date, or null when using `dueInDays`."},"dueInDays":{"type":"integer","nullable":true,"minimum":0,"maximum":3650,"description":"Offset from the send date (INT-F19)."},"message":{"type":"string","nullable":true,"maxLength":4000,"description":"Message to the client."},"recipients":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^(client|all_recipients|organisation|applicant_[1-9][0-9]?)$","description":"Assignee slot: client, all_recipients, organisation or applicant_<n>."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group bound to the slot; null for `organisation`."},"groupLabel":{"type":"string","nullable":true,"description":"Display label of the group (slot label in the review queue)."}},"required":["slot","groupId","groupLabel"],"description":"Slot → room group binding of a flow (INT-F03)."},"minItems":1,"maxItems":20,"description":"Slot → group bindings (INT-F03)."},"conditionValues":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"enabled":{"type":"boolean"}},"required":["code","enabled"],"description":"Condition state of a flow (INT-F04)."},"maxItems":50,"description":"Condition switches (INT-F04)."},"reminderPolicy":{"type":"object","nullable":true,"properties":{"offsetsInDays":{"type":"array","items":{"type":"integer","minimum":1,"maximum":365},"maxItems":20,"description":"Days after send to remind open items; ascending and deduplicated."},"maxReminders":{"type":"integer","minimum":0,"maximum":20,"description":"Upper bound of reminders per flow."}},"required":["offsetsInDays","maxReminders"],"additionalProperties":false,"description":"Overrides the template reminder policy."}},"required":["templateVersionId","title","dueDate","dueInDays","message","recipients","conditionValues","reminderPolicy"],"additionalProperties":false,"description":"Create a flow draft in a room (INT-F03)."},{"type":"object","properties":{"templateId":{"type":"string","nullable":true,"maxLength":100},"title":{"type":"string","minLength":1,"maxLength":200},"message":{"type":"string","nullable":true,"maxLength":4000},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"maxLength":6000,"description":"Cover \"Instructies\" page (safe rich-text subset, sanitised on the server)."},"recipient":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"email":{"type":"string","maxLength":320,"format":"email"}},"required":["name","email"],"description":"The one person a request is addressed to (client data)."},"applicants":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"name":{"type":"string","minLength":1,"maxLength":200},"email":{"type":"string","maxLength":320,"format":"email"}},"required":["slot","name","email"],"description":"One applicant slot of a shared request with its own name and e-mail (client data)."},"minItems":1,"maxItems":10,"description":"Applicants of a shared request (M2/HYP-03). Absent: the single `recipient` is applicant_1. When present it must include `applicant_1`, which must match `recipient`."},"partyScope":{"type":"object","properties":{"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group bound to the party; null until the firm binds it."}},"required":["slot","label","groupId"],"additionalProperties":false,"description":"Room-bound party of a request (WF01): applicant slot, display label, room group."},"minItems":1,"maxItems":10},"joint":{"type":"boolean"}},"required":["parties","joint"],"additionalProperties":false,"description":"Party scope of the request (WF01): named room parties plus the joint flag. Absent: ordinary behaviour without named parties. When present every applicant slot needs exactly one party entry."},"periodKey":{"type":"string","pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period the new request collects evidence for (WF06, e.g. the next boekjaar). Absent: no period. Copy provenance is server-authoritative and never taken from the create body."},"sections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":200},"instructions":{"type":"string","nullable":true,"maxLength":4000},"items":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":200},"instructions":{"type":"string","nullable":true,"maxLength":6000},"footnote":{"type":"string","nullable":true,"maxLength":2000},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for; null or absent is shared."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"prefill":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot the draft belongs to; defaults to `applicant_1`."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."}},"required":["value"],"additionalProperties":false},"minItems":1,"maxItems":20,"description":"Seed editable draft answers when the item is created (copy from a previous request). Validated against the item kind/rules; submitted/review state is not carried."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named item icon of the request form (ADR-0048); the web maps it onto the icon set."},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"allowMultiple":{"type":"boolean"},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50},"targetFolderId":{"type":"string","nullable":true,"format":"uuid"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"bsnAutoMask":{"type":"boolean","description":"Burn every BSN out of a delivered file before the item can be approved (ADR-0053). Absent: the template default of the item, else off."},"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650,"description":"Validity rule in days (ADR-0053). Absent: the template default of the item, else none."}},"required":["title","instructions","required","allowNotApplicable","targetFolderId","dueDate"],"additionalProperties":false},"maxItems":100},"subsections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":200},"instructions":{"type":"string","nullable":true,"maxLength":4000},"items":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":200},"instructions":{"type":"string","nullable":true,"maxLength":6000},"footnote":{"type":"string","nullable":true,"maxLength":2000},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for; null or absent is shared."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"prefill":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot the draft belongs to; defaults to `applicant_1`."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."}},"required":["value"],"additionalProperties":false},"minItems":1,"maxItems":20,"description":"Seed editable draft answers when the item is created (copy from a previous request). Validated against the item kind/rules; submitted/review state is not carried."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named item icon of the request form (ADR-0048); the web maps it onto the icon set."},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"allowMultiple":{"type":"boolean"},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50},"targetFolderId":{"type":"string","nullable":true,"format":"uuid"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"bsnAutoMask":{"type":"boolean","description":"Burn every BSN out of a delivered file before the item can be approved (ADR-0053). Absent: the template default of the item, else off."},"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650,"description":"Validity rule in days (ADR-0053). Absent: the template default of the item, else none."}},"required":["title","instructions","required","allowNotApplicable","targetFolderId","dueDate"],"additionalProperties":false},"maxItems":100}},"required":["title","instructions","items"],"additionalProperties":false},"maxItems":50},"repeatGroup":{"type":"object","nullable":true,"properties":{"name":{"type":"string","minLength":1,"maxLength":200,"description":"Stable group name (the template section title)."},"index":{"type":"integer","minimum":0,"maximum":19,"description":"This repeat (0-based)."},"total":{"type":"integer","minimum":1,"maximum":20,"description":"Repeats of this group in this request."},"min":{"type":"integer","minimum":0,"maximum":10,"description":"Template-declared minimum of the group."},"max":{"type":"integer","minimum":1,"maximum":20,"description":"Template-declared maximum of the group."}},"required":["name","index","total","min","max"],"additionalProperties":false,"description":"Repeat membership (PRF-03): set when this block is one repeat of a template-declared group; absent or null is an ordinary block."}},"required":["title","instructions","items"],"additionalProperties":false},"minItems":1,"maxItems":50}},"required":["templateId","title","message","dueDate","recipient","sections"],"additionalProperties":false,"description":"Create a request draft (request-flow profile). At least one item."}]}}}},"responses":{"201":{"description":"Draft flow.","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"tenantId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"templateVersionId":{"type":"string","nullable":true,"format":"uuid","description":"Frozen template version (null for a blank request)."},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"title":{"type":"string"},"message":{"type":"string","nullable":true,"description":"Message to the client; shown in the portal."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipients":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^(client|all_recipients|organisation|applicant_[1-9][0-9]?)$","description":"Assignee slot: client, all_recipients, organisation or applicant_<n>."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group bound to the slot; null for `organisation`."},"groupLabel":{"type":"string","nullable":true,"description":"Display label of the group (slot label in the review queue)."}},"required":["slot","groupId","groupLabel"],"description":"Slot → room group binding of a flow (INT-F03)."}},"conditionValues":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"enabled":{"type":"boolean"}},"required":["code","enabled"],"description":"Condition state of a flow (INT-F04)."}},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"],"description":"Portal counters."},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"],"description":"Firm counters."},"sections":{"type":"array","items":{"type":"object","properties":{"sectionId":{"type":"string","format":"uuid"},"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["sectionId","done","total"],"description":"Per-section counters (INT-F18)."},"description":"Counters per visible section."}},"required":["client","firm","sections"],"description":"Progress of a flow for one viewer (INT-F18)."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"parentSectionId":{"type":"string","nullable":true,"format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"itemCount":{"type":"integer","minimum":0}},"required":["id","parentSectionId","position","title","instructions","itemCount"],"description":"Section view (INT-F04)."},"description":"Visible sections, numbered for the viewer."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"flowId":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"type":{"type":"string","enum":["file","text","number","date","choice","acknowledgement","instructions"],"description":"Item type (INT-F05)."},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"status":{"type":"string","enum":["to_do","submitted","in_review","approved","rejected","not_applicable","cancelled"],"description":"Item status (INT-F14)."},"revision":{"type":"integer","minimum":0,"description":"View revision for optimistic concurrency (INT-F14)."},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"assignees":{"type":"array","items":{"type":"string","pattern":"^(client|all_recipients|organisation|applicant_[1-9][0-9]?)$","description":"Assignee slot: client, all_recipients, organisation or applicant_<n>."}},"visibility":{"type":"string","enum":["assignees","internal","shared_on_approval"],"description":"Item visibility (INT-F06, INT-F07)."},"review":{"type":"string","enum":["required","none"],"description":"Review mode: `required` gates on a professional decision, `none` is accepted on submit."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"overdue":{"type":"boolean","description":"Derived: due date passed and status `to_do` or `rejected`."},"skippedAt":{"type":"string","nullable":true,"format":"date-time","description":"Latest skip marker (INT-F12)."},"lastSubmissionKind":{"type":"string","nullable":true,"enum":["files","answer","acknowledgement","not_applicable",null],"description":"Submission kind (INT-F11, INT-F12)."},"submission":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"itemId":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["files","answer","acknowledgement","not_applicable"],"description":"Submission kind (INT-F11, INT-F12)."},"decision":{"type":"string","enum":["pending","approved","rejected","superseded"],"description":"Submission decision (ADR-0013 D2, INT-F16)."},"baseItemRevision":{"type":"integer","minimum":0},"submittedByPrincipalId":{"type":"string","nullable":true,"format":"uuid"},"submittedAt":{"type":"string","format":"date-time"},"authStrength":{"type":"string","enum":["single","mfa"],"description":"Recorded auth strength (ADR-0013 D1)."},"decidedBy":{"type":"string","nullable":true,"format":"uuid"},"decidedAt":{"type":"string","nullable":true,"format":"date-time"},"reasonCode":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Decision reason code; text lives in the encrypted note."},"noteId":{"type":"string","nullable":true,"format":"uuid","description":"Opaque reason-note id; reading it writes `note.read`."},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Document date set at approval (HYP-06)."},"files":{"type":"array","items":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"sha256Hex":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the original (receipt, AUD-09)."},"sizePlain":{"type":"integer","nullable":true,"minimum":0,"description":"Plaintext size in bytes."},"scanState":{"type":"string","enum":["scanning","available","rejected","failed"],"description":"ADR-0007 version status."}},"required":["versionId","documentId","sha256Hex","sizePlain","scanState"],"description":"One file of a submission (no file names)."},"description":"Files of a `files` submission."}},"required":["id","itemId","kind","decision","baseItemRevision","submittedByPrincipalId","submittedAt","authStrength","decidedBy","decidedAt","reasonCode","noteId","documentDate","files"],"description":"Open submission, when the view shows `submitted`."},"fileRules":{"type":"object","nullable":true,"properties":{"minFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Minimum files to submit (default 1)."},"maxFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Maximum files (default 1, max 50)."},"allowedKinds":{"type":"array","items":{"type":"string","enum":["pdf","image","office","email","any"],"description":"Accepted file kind, checked by content at scan (SEC-08)."},"minItems":1,"maxItems":5,"description":"Accepted kinds, checked by content at scan (SEC-08); `any` covers the rest."},"maxFileBytes":{"type":"integer","minimum":1,"maximum":5368709120,"description":"Per-file size cap in bytes (default 100 MiB, never above 5 GiB, DOC-16)."},"camera":{"type":"boolean","description":"Offer camera capture for images/PDF (HYP-02)."}},"additionalProperties":false,"description":"File rules of a `file` item (INT-F06). Omitted fields fall back to `flowFileRulesDefaults`."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":20000,"description":"`text`: maximum length in characters (default 2000)."},"min":{"type":"number","nullable":true,"description":"`number`: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"`number`: inclusive maximum."},"decimals":{"type":"integer","nullable":true,"minimum":0,"maximum":6,"description":"`number`: allowed decimals."},"unit":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"`number`: unit label (for example \"years\")."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false,"description":"Choice option of a `choice` item."},"maxItems":50,"description":"`choice`: the options."},"multiple":{"type":"boolean","description":"`choice`: allow more than one option."}},"additionalProperties":false,"description":"Answer rules of a `text`, `number`, `date` or `choice` item (INT-F05). Omitted fields fall back to `flowAnswerRulesDefaults`."},"group":{"type":"object","nullable":true,"properties":{"groupId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Group id within the template (E20 `required: \"group\"`)."},"satisfiedBy":{"type":"string","enum":["any_of"],"description":"Only `any_of` in the MVP: one approved option satisfies the group."},"option":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Option code of this item within the group."}},"required":["groupId","satisfiedBy","option"],"additionalProperties":false,"description":"Group of alternatives (E20 `required: \"group\"`, INT-F06)."},"documentType":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"validity":{"type":"object","nullable":true,"properties":{"rule":{"type":"string","enum":["none","max_age","not_expired","covers_years"],"description":"E20 validity rule (HYP-06)."},"months":{"type":"integer","nullable":true,"minimum":0,"maximum":600,"description":"Age or cover window in months."}},"required":["rule","months"],"additionalProperties":false,"description":"E20 validity rule (HYP-06)."},"bsnSensitive":{"type":"boolean"},"idPhotoMustStayVisible":{"type":"boolean"}},"required":["id","flowId","sectionId","position","type","title","instructions","status","revision","required","allowNotApplicable","assignees","visibility","review","dueDate","overdue","skippedAt","lastSubmissionKind","submission","fileRules","answerRules","group","documentType","validity","bsnSensitive","idPhotoMustStayVisible"],"description":"Item view computed from firm-written and guest-owned rows (INT-F07a)."},"description":"Visible item views (INT-F07)."},"createdAt":{"type":"string","format":"date-time"},"sentAt":{"type":"string","nullable":true,"format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","tenantId","roomId","templateVersionId","status","title","message","dueDate","recipients","conditionValues","progress","sections","items","createdAt","sentAt","completedAt"],"description":"Flow instance with the viewer-visible sections, items and progress (INT-F03, INT-F18)."},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"templateId":{"type":"string","nullable":true,"maxLength":100},"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipient":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"email":{"type":"string","maxLength":320,"format":"email"}},"required":["name","email"],"description":"The one person a request is addressed to (client data)."},"portalUrl":{"type":"string","nullable":true,"description":"Always null on the real stack: the link token is only ever in the request e-mail."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group bound to the party; null until the firm binds it."}},"required":["slot","label","groupId"],"additionalProperties":false,"description":"Room-bound party of a request (WF01): applicant slot, display label, room group."},"description":"Named room parties of this request (WF01); empty on legacy rows without a scope."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): bound parties share drafts. False keeps slot-private answers."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance. Null on legacy rows without a period."},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."},"targetFolderId":{"type":"string","nullable":true,"format":"uuid","description":"Room-index folder the approved files go into; null = root."},"targetFolderTitle":{"type":"string","nullable":true},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"overdue":{"type":"boolean"},"authStrength":{"type":"string","nullable":true,"enum":["single","mfa",null],"description":"Strength of the client session that submitted the item (ADR-0013 D1 condition 1)."},"bsnAutoMask":{"type":"boolean","description":"The worker burns every BSN out of a delivered file before approval (ADR-0053)."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number","targetFolderId","targetFolderTitle","submittedAt","overdue","authStrength"],"description":"Request item as the firm sees it."}},"createdAt":{"type":"string","format":"date-time"},"sentAt":{"type":"string","nullable":true,"format":"date-time"},"openedAt":{"type":"string","nullable":true,"format":"date-time"},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"reminders":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"description":"Reminders sent so far (automatic and manual)."},"lastAt":{"type":"string","nullable":true,"format":"date-time"},"nextAt":{"type":"string","nullable":true,"format":"date-time","description":"Next automatic reminder; null when none is due."},"paused":{"type":"boolean"}},"required":["count","lastAt","nextAt","paused"],"description":"Reminder state (ADR-0053)."}},"required":["id","roomId","templateId","title","message","status","dueDate","recipient","portalUrl","parties","joint","periodContext","expiresAt","coverInstructions","displayStatus","progress","sections","items","createdAt","sentAt","openedAt","submittedAt","completedAt","updatedAt"],"description":"Document request (request-flow profile, firm view)."}]}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (member without manage).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or template version.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"422":{"description":"SLOT_GROUP_INVALID or TARGET_INTERNAL (INT-F03, INT-F08).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/flows/{flowId}":{"get":{"operationId":"getFlow","summary":"Read a flow","description":"Flow state, recipients, conditions, progress and the sections/items visible to the caller (INT-F03, INT-F07, INT-F18). Guests 404 on a draft. Never carries answer values (ADR-0013 D2). Requires flow.read; 404 hides existence (including cross-tenant).","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"}],"responses":{"200":{"description":"Flow.","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"tenantId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"templateVersionId":{"type":"string","nullable":true,"format":"uuid","description":"Frozen template version (null for a blank request)."},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"title":{"type":"string"},"message":{"type":"string","nullable":true,"description":"Message to the client; shown in the portal."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipients":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^(client|all_recipients|organisation|applicant_[1-9][0-9]?)$","description":"Assignee slot: client, all_recipients, organisation or applicant_<n>."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group bound to the slot; null for `organisation`."},"groupLabel":{"type":"string","nullable":true,"description":"Display label of the group (slot label in the review queue)."}},"required":["slot","groupId","groupLabel"],"description":"Slot → room group binding of a flow (INT-F03)."}},"conditionValues":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"enabled":{"type":"boolean"}},"required":["code","enabled"],"description":"Condition state of a flow (INT-F04)."}},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"],"description":"Portal counters."},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"],"description":"Firm counters."},"sections":{"type":"array","items":{"type":"object","properties":{"sectionId":{"type":"string","format":"uuid"},"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["sectionId","done","total"],"description":"Per-section counters (INT-F18)."},"description":"Counters per visible section."}},"required":["client","firm","sections"],"description":"Progress of a flow for one viewer (INT-F18)."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"parentSectionId":{"type":"string","nullable":true,"format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"itemCount":{"type":"integer","minimum":0}},"required":["id","parentSectionId","position","title","instructions","itemCount"],"description":"Section view (INT-F04)."},"description":"Visible sections, numbered for the viewer."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"flowId":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"type":{"type":"string","enum":["file","text","number","date","choice","acknowledgement","instructions"],"description":"Item type (INT-F05)."},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"status":{"type":"string","enum":["to_do","submitted","in_review","approved","rejected","not_applicable","cancelled"],"description":"Item status (INT-F14)."},"revision":{"type":"integer","minimum":0,"description":"View revision for optimistic concurrency (INT-F14)."},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"assignees":{"type":"array","items":{"type":"string","pattern":"^(client|all_recipients|organisation|applicant_[1-9][0-9]?)$","description":"Assignee slot: client, all_recipients, organisation or applicant_<n>."}},"visibility":{"type":"string","enum":["assignees","internal","shared_on_approval"],"description":"Item visibility (INT-F06, INT-F07)."},"review":{"type":"string","enum":["required","none"],"description":"Review mode: `required` gates on a professional decision, `none` is accepted on submit."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"overdue":{"type":"boolean","description":"Derived: due date passed and status `to_do` or `rejected`."},"skippedAt":{"type":"string","nullable":true,"format":"date-time","description":"Latest skip marker (INT-F12)."},"lastSubmissionKind":{"type":"string","nullable":true,"enum":["files","answer","acknowledgement","not_applicable",null],"description":"Submission kind (INT-F11, INT-F12)."},"submission":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"itemId":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["files","answer","acknowledgement","not_applicable"],"description":"Submission kind (INT-F11, INT-F12)."},"decision":{"type":"string","enum":["pending","approved","rejected","superseded"],"description":"Submission decision (ADR-0013 D2, INT-F16)."},"baseItemRevision":{"type":"integer","minimum":0},"submittedByPrincipalId":{"type":"string","nullable":true,"format":"uuid"},"submittedAt":{"type":"string","format":"date-time"},"authStrength":{"type":"string","enum":["single","mfa"],"description":"Recorded auth strength (ADR-0013 D1)."},"decidedBy":{"type":"string","nullable":true,"format":"uuid"},"decidedAt":{"type":"string","nullable":true,"format":"date-time"},"reasonCode":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Decision reason code; text lives in the encrypted note."},"noteId":{"type":"string","nullable":true,"format":"uuid","description":"Opaque reason-note id; reading it writes `note.read`."},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Document date set at approval (HYP-06)."},"files":{"type":"array","items":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"sha256Hex":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the original (receipt, AUD-09)."},"sizePlain":{"type":"integer","nullable":true,"minimum":0,"description":"Plaintext size in bytes."},"scanState":{"type":"string","enum":["scanning","available","rejected","failed"],"description":"ADR-0007 version status."}},"required":["versionId","documentId","sha256Hex","sizePlain","scanState"],"description":"One file of a submission (no file names)."},"description":"Files of a `files` submission."}},"required":["id","itemId","kind","decision","baseItemRevision","submittedByPrincipalId","submittedAt","authStrength","decidedBy","decidedAt","reasonCode","noteId","documentDate","files"],"description":"Open submission, when the view shows `submitted`."},"fileRules":{"type":"object","nullable":true,"properties":{"minFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Minimum files to submit (default 1)."},"maxFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Maximum files (default 1, max 50)."},"allowedKinds":{"type":"array","items":{"type":"string","enum":["pdf","image","office","email","any"],"description":"Accepted file kind, checked by content at scan (SEC-08)."},"minItems":1,"maxItems":5,"description":"Accepted kinds, checked by content at scan (SEC-08); `any` covers the rest."},"maxFileBytes":{"type":"integer","minimum":1,"maximum":5368709120,"description":"Per-file size cap in bytes (default 100 MiB, never above 5 GiB, DOC-16)."},"camera":{"type":"boolean","description":"Offer camera capture for images/PDF (HYP-02)."}},"additionalProperties":false,"description":"File rules of a `file` item (INT-F06). Omitted fields fall back to `flowFileRulesDefaults`."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":20000,"description":"`text`: maximum length in characters (default 2000)."},"min":{"type":"number","nullable":true,"description":"`number`: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"`number`: inclusive maximum."},"decimals":{"type":"integer","nullable":true,"minimum":0,"maximum":6,"description":"`number`: allowed decimals."},"unit":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"`number`: unit label (for example \"years\")."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false,"description":"Choice option of a `choice` item."},"maxItems":50,"description":"`choice`: the options."},"multiple":{"type":"boolean","description":"`choice`: allow more than one option."}},"additionalProperties":false,"description":"Answer rules of a `text`, `number`, `date` or `choice` item (INT-F05). Omitted fields fall back to `flowAnswerRulesDefaults`."},"group":{"type":"object","nullable":true,"properties":{"groupId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Group id within the template (E20 `required: \"group\"`)."},"satisfiedBy":{"type":"string","enum":["any_of"],"description":"Only `any_of` in the MVP: one approved option satisfies the group."},"option":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Option code of this item within the group."}},"required":["groupId","satisfiedBy","option"],"additionalProperties":false,"description":"Group of alternatives (E20 `required: \"group\"`, INT-F06)."},"documentType":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"validity":{"type":"object","nullable":true,"properties":{"rule":{"type":"string","enum":["none","max_age","not_expired","covers_years"],"description":"E20 validity rule (HYP-06)."},"months":{"type":"integer","nullable":true,"minimum":0,"maximum":600,"description":"Age or cover window in months."}},"required":["rule","months"],"additionalProperties":false,"description":"E20 validity rule (HYP-06)."},"bsnSensitive":{"type":"boolean"},"idPhotoMustStayVisible":{"type":"boolean"}},"required":["id","flowId","sectionId","position","type","title","instructions","status","revision","required","allowNotApplicable","assignees","visibility","review","dueDate","overdue","skippedAt","lastSubmissionKind","submission","fileRules","answerRules","group","documentType","validity","bsnSensitive","idPhotoMustStayVisible"],"description":"Item view computed from firm-written and guest-owned rows (INT-F07a)."},"description":"Visible item views (INT-F07)."},"createdAt":{"type":"string","format":"date-time"},"sentAt":{"type":"string","nullable":true,"format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","tenantId","roomId","templateVersionId","status","title","message","dueDate","recipients","conditionValues","progress","sections","items","createdAt","sentAt","completedAt"],"description":"Flow instance with the viewer-visible sections, items and progress (INT-F03, INT-F18)."},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"templateId":{"type":"string","nullable":true,"maxLength":100},"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipient":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"email":{"type":"string","maxLength":320,"format":"email"}},"required":["name","email"],"description":"The one person a request is addressed to (client data)."},"portalUrl":{"type":"string","nullable":true,"description":"Always null on the real stack: the link token is only ever in the request e-mail."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group bound to the party; null until the firm binds it."}},"required":["slot","label","groupId"],"additionalProperties":false,"description":"Room-bound party of a request (WF01): applicant slot, display label, room group."},"description":"Named room parties of this request (WF01); empty on legacy rows without a scope."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): bound parties share drafts. False keeps slot-private answers."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance. Null on legacy rows without a period."},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."},"targetFolderId":{"type":"string","nullable":true,"format":"uuid","description":"Room-index folder the approved files go into; null = root."},"targetFolderTitle":{"type":"string","nullable":true},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"overdue":{"type":"boolean"},"authStrength":{"type":"string","nullable":true,"enum":["single","mfa",null],"description":"Strength of the client session that submitted the item (ADR-0013 D1 condition 1)."},"bsnAutoMask":{"type":"boolean","description":"The worker burns every BSN out of a delivered file before approval (ADR-0053)."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number","targetFolderId","targetFolderTitle","submittedAt","overdue","authStrength"],"description":"Request item as the firm sees it."}},"createdAt":{"type":"string","format":"date-time"},"sentAt":{"type":"string","nullable":true,"format":"date-time"},"openedAt":{"type":"string","nullable":true,"format":"date-time"},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"reminders":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"description":"Reminders sent so far (automatic and manual)."},"lastAt":{"type":"string","nullable":true,"format":"date-time"},"nextAt":{"type":"string","nullable":true,"format":"date-time","description":"Next automatic reminder; null when none is due."},"paused":{"type":"boolean"}},"required":["count","lastAt","nextAt","paused"],"description":"Reminder state (ADR-0053)."}},"required":["id","roomId","templateId","title","message","status","dueDate","recipient","portalUrl","parties","joint","periodContext","expiresAt","coverInstructions","displayStatus","progress","sections","items","createdAt","sentAt","openedAt","submittedAt","completedAt","updatedAt"],"description":"Document request (request-flow profile, firm view)."}]}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or flow, or no access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"put":{"operationId":"updateFlow","summary":"Edit a draft flow","description":"Edits title, due date, message, recipients, conditions and reminders of a draft (INT-F03, INT-F04). Refused once sent (409 FLOW_NOT_ACTIVE). Requires flow.update; writes flow.updated and flow.conditions_changed when condition codes change.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":200},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"dueInDays":{"type":"integer","nullable":true,"minimum":0,"maximum":3650},"message":{"type":"string","nullable":true,"maxLength":4000},"recipients":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^(client|all_recipients|organisation|applicant_[1-9][0-9]?)$","description":"Assignee slot: client, all_recipients, organisation or applicant_<n>."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group bound to the slot; null for `organisation`."},"groupLabel":{"type":"string","nullable":true,"description":"Display label of the group (slot label in the review queue)."}},"required":["slot","groupId","groupLabel"],"description":"Slot → room group binding of a flow (INT-F03)."},"minItems":1,"maxItems":20},"conditionValues":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"enabled":{"type":"boolean"}},"required":["code","enabled"],"description":"Condition state of a flow (INT-F04)."},"maxItems":50},"reminderPolicy":{"type":"object","nullable":true,"properties":{"offsetsInDays":{"type":"array","items":{"type":"integer","minimum":1,"maximum":365},"maxItems":20,"description":"Days after send to remind open items; ascending and deduplicated."},"maxReminders":{"type":"integer","minimum":0,"maximum":20,"description":"Upper bound of reminders per flow."}},"required":["offsetsInDays","maxReminders"],"additionalProperties":false,"description":"Reminder policy of a template (INT-F19)."}},"additionalProperties":false,"description":"Edit a draft flow (INT-F03)."}}}},"responses":{"200":{"description":"Updated flow.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"tenantId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"templateVersionId":{"type":"string","nullable":true,"format":"uuid","description":"Frozen template version (null for a blank request)."},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"title":{"type":"string"},"message":{"type":"string","nullable":true,"description":"Message to the client; shown in the portal."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipients":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^(client|all_recipients|organisation|applicant_[1-9][0-9]?)$","description":"Assignee slot: client, all_recipients, organisation or applicant_<n>."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group bound to the slot; null for `organisation`."},"groupLabel":{"type":"string","nullable":true,"description":"Display label of the group (slot label in the review queue)."}},"required":["slot","groupId","groupLabel"],"description":"Slot → room group binding of a flow (INT-F03)."}},"conditionValues":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"enabled":{"type":"boolean"}},"required":["code","enabled"],"description":"Condition state of a flow (INT-F04)."}},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"],"description":"Portal counters."},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"],"description":"Firm counters."},"sections":{"type":"array","items":{"type":"object","properties":{"sectionId":{"type":"string","format":"uuid"},"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["sectionId","done","total"],"description":"Per-section counters (INT-F18)."},"description":"Counters per visible section."}},"required":["client","firm","sections"],"description":"Progress of a flow for one viewer (INT-F18)."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"parentSectionId":{"type":"string","nullable":true,"format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"itemCount":{"type":"integer","minimum":0}},"required":["id","parentSectionId","position","title","instructions","itemCount"],"description":"Section view (INT-F04)."},"description":"Visible sections, numbered for the viewer."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"flowId":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"type":{"type":"string","enum":["file","text","number","date","choice","acknowledgement","instructions"],"description":"Item type (INT-F05)."},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"status":{"type":"string","enum":["to_do","submitted","in_review","approved","rejected","not_applicable","cancelled"],"description":"Item status (INT-F14)."},"revision":{"type":"integer","minimum":0,"description":"View revision for optimistic concurrency (INT-F14)."},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"assignees":{"type":"array","items":{"type":"string","pattern":"^(client|all_recipients|organisation|applicant_[1-9][0-9]?)$","description":"Assignee slot: client, all_recipients, organisation or applicant_<n>."}},"visibility":{"type":"string","enum":["assignees","internal","shared_on_approval"],"description":"Item visibility (INT-F06, INT-F07)."},"review":{"type":"string","enum":["required","none"],"description":"Review mode: `required` gates on a professional decision, `none` is accepted on submit."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"overdue":{"type":"boolean","description":"Derived: due date passed and status `to_do` or `rejected`."},"skippedAt":{"type":"string","nullable":true,"format":"date-time","description":"Latest skip marker (INT-F12)."},"lastSubmissionKind":{"type":"string","nullable":true,"enum":["files","answer","acknowledgement","not_applicable",null],"description":"Submission kind (INT-F11, INT-F12)."},"submission":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"itemId":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["files","answer","acknowledgement","not_applicable"],"description":"Submission kind (INT-F11, INT-F12)."},"decision":{"type":"string","enum":["pending","approved","rejected","superseded"],"description":"Submission decision (ADR-0013 D2, INT-F16)."},"baseItemRevision":{"type":"integer","minimum":0},"submittedByPrincipalId":{"type":"string","nullable":true,"format":"uuid"},"submittedAt":{"type":"string","format":"date-time"},"authStrength":{"type":"string","enum":["single","mfa"],"description":"Recorded auth strength (ADR-0013 D1)."},"decidedBy":{"type":"string","nullable":true,"format":"uuid"},"decidedAt":{"type":"string","nullable":true,"format":"date-time"},"reasonCode":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Decision reason code; text lives in the encrypted note."},"noteId":{"type":"string","nullable":true,"format":"uuid","description":"Opaque reason-note id; reading it writes `note.read`."},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Document date set at approval (HYP-06)."},"files":{"type":"array","items":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"sha256Hex":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the original (receipt, AUD-09)."},"sizePlain":{"type":"integer","nullable":true,"minimum":0,"description":"Plaintext size in bytes."},"scanState":{"type":"string","enum":["scanning","available","rejected","failed"],"description":"ADR-0007 version status."}},"required":["versionId","documentId","sha256Hex","sizePlain","scanState"],"description":"One file of a submission (no file names)."},"description":"Files of a `files` submission."}},"required":["id","itemId","kind","decision","baseItemRevision","submittedByPrincipalId","submittedAt","authStrength","decidedBy","decidedAt","reasonCode","noteId","documentDate","files"],"description":"Open submission, when the view shows `submitted`."},"fileRules":{"type":"object","nullable":true,"properties":{"minFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Minimum files to submit (default 1)."},"maxFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Maximum files (default 1, max 50)."},"allowedKinds":{"type":"array","items":{"type":"string","enum":["pdf","image","office","email","any"],"description":"Accepted file kind, checked by content at scan (SEC-08)."},"minItems":1,"maxItems":5,"description":"Accepted kinds, checked by content at scan (SEC-08); `any` covers the rest."},"maxFileBytes":{"type":"integer","minimum":1,"maximum":5368709120,"description":"Per-file size cap in bytes (default 100 MiB, never above 5 GiB, DOC-16)."},"camera":{"type":"boolean","description":"Offer camera capture for images/PDF (HYP-02)."}},"additionalProperties":false,"description":"File rules of a `file` item (INT-F06). Omitted fields fall back to `flowFileRulesDefaults`."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":20000,"description":"`text`: maximum length in characters (default 2000)."},"min":{"type":"number","nullable":true,"description":"`number`: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"`number`: inclusive maximum."},"decimals":{"type":"integer","nullable":true,"minimum":0,"maximum":6,"description":"`number`: allowed decimals."},"unit":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"`number`: unit label (for example \"years\")."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false,"description":"Choice option of a `choice` item."},"maxItems":50,"description":"`choice`: the options."},"multiple":{"type":"boolean","description":"`choice`: allow more than one option."}},"additionalProperties":false,"description":"Answer rules of a `text`, `number`, `date` or `choice` item (INT-F05). Omitted fields fall back to `flowAnswerRulesDefaults`."},"group":{"type":"object","nullable":true,"properties":{"groupId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Group id within the template (E20 `required: \"group\"`)."},"satisfiedBy":{"type":"string","enum":["any_of"],"description":"Only `any_of` in the MVP: one approved option satisfies the group."},"option":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Option code of this item within the group."}},"required":["groupId","satisfiedBy","option"],"additionalProperties":false,"description":"Group of alternatives (E20 `required: \"group\"`, INT-F06)."},"documentType":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"validity":{"type":"object","nullable":true,"properties":{"rule":{"type":"string","enum":["none","max_age","not_expired","covers_years"],"description":"E20 validity rule (HYP-06)."},"months":{"type":"integer","nullable":true,"minimum":0,"maximum":600,"description":"Age or cover window in months."}},"required":["rule","months"],"additionalProperties":false,"description":"E20 validity rule (HYP-06)."},"bsnSensitive":{"type":"boolean"},"idPhotoMustStayVisible":{"type":"boolean"}},"required":["id","flowId","sectionId","position","type","title","instructions","status","revision","required","allowNotApplicable","assignees","visibility","review","dueDate","overdue","skippedAt","lastSubmissionKind","submission","fileRules","answerRules","group","documentType","validity","bsnSensitive","idPhotoMustStayVisible"],"description":"Item view computed from firm-written and guest-owned rows (INT-F07a)."},"description":"Visible item views (INT-F07)."},"createdAt":{"type":"string","format":"date-time"},"sentAt":{"type":"string","nullable":true,"format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","tenantId","roomId","templateVersionId","status","title","message","dueDate","recipients","conditionValues","progress","sections","items","createdAt","sentAt","completedAt"],"description":"Flow instance with the viewer-visible sections, items and progress (INT-F03, INT-F18)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no update permission).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or flow.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"FLOW_NOT_ACTIVE: the flow is no longer a draft.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"422":{"description":"SLOT_GROUP_INVALID or TARGET_INTERNAL.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/flows/{flowId}/send":{"post":{"operationId":"sendFlow","summary":"Send a flow to its recipients","description":"Creates item nodes and item-scoped assignments in one transaction and makes the flow visible to the client groups (INT-F03, INT-F08). Requires flow.send; writes flow.sent.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"}],"responses":{"200":{"description":"Sent flow.","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"tenantId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"templateVersionId":{"type":"string","nullable":true,"format":"uuid","description":"Frozen template version (null for a blank request)."},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"title":{"type":"string"},"message":{"type":"string","nullable":true,"description":"Message to the client; shown in the portal."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipients":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^(client|all_recipients|organisation|applicant_[1-9][0-9]?)$","description":"Assignee slot: client, all_recipients, organisation or applicant_<n>."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group bound to the slot; null for `organisation`."},"groupLabel":{"type":"string","nullable":true,"description":"Display label of the group (slot label in the review queue)."}},"required":["slot","groupId","groupLabel"],"description":"Slot → room group binding of a flow (INT-F03)."}},"conditionValues":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"enabled":{"type":"boolean"}},"required":["code","enabled"],"description":"Condition state of a flow (INT-F04)."}},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"],"description":"Portal counters."},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"],"description":"Firm counters."},"sections":{"type":"array","items":{"type":"object","properties":{"sectionId":{"type":"string","format":"uuid"},"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["sectionId","done","total"],"description":"Per-section counters (INT-F18)."},"description":"Counters per visible section."}},"required":["client","firm","sections"],"description":"Progress of a flow for one viewer (INT-F18)."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"parentSectionId":{"type":"string","nullable":true,"format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"itemCount":{"type":"integer","minimum":0}},"required":["id","parentSectionId","position","title","instructions","itemCount"],"description":"Section view (INT-F04)."},"description":"Visible sections, numbered for the viewer."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"flowId":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"type":{"type":"string","enum":["file","text","number","date","choice","acknowledgement","instructions"],"description":"Item type (INT-F05)."},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"status":{"type":"string","enum":["to_do","submitted","in_review","approved","rejected","not_applicable","cancelled"],"description":"Item status (INT-F14)."},"revision":{"type":"integer","minimum":0,"description":"View revision for optimistic concurrency (INT-F14)."},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"assignees":{"type":"array","items":{"type":"string","pattern":"^(client|all_recipients|organisation|applicant_[1-9][0-9]?)$","description":"Assignee slot: client, all_recipients, organisation or applicant_<n>."}},"visibility":{"type":"string","enum":["assignees","internal","shared_on_approval"],"description":"Item visibility (INT-F06, INT-F07)."},"review":{"type":"string","enum":["required","none"],"description":"Review mode: `required` gates on a professional decision, `none` is accepted on submit."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"overdue":{"type":"boolean","description":"Derived: due date passed and status `to_do` or `rejected`."},"skippedAt":{"type":"string","nullable":true,"format":"date-time","description":"Latest skip marker (INT-F12)."},"lastSubmissionKind":{"type":"string","nullable":true,"enum":["files","answer","acknowledgement","not_applicable",null],"description":"Submission kind (INT-F11, INT-F12)."},"submission":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"itemId":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["files","answer","acknowledgement","not_applicable"],"description":"Submission kind (INT-F11, INT-F12)."},"decision":{"type":"string","enum":["pending","approved","rejected","superseded"],"description":"Submission decision (ADR-0013 D2, INT-F16)."},"baseItemRevision":{"type":"integer","minimum":0},"submittedByPrincipalId":{"type":"string","nullable":true,"format":"uuid"},"submittedAt":{"type":"string","format":"date-time"},"authStrength":{"type":"string","enum":["single","mfa"],"description":"Recorded auth strength (ADR-0013 D1)."},"decidedBy":{"type":"string","nullable":true,"format":"uuid"},"decidedAt":{"type":"string","nullable":true,"format":"date-time"},"reasonCode":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Decision reason code; text lives in the encrypted note."},"noteId":{"type":"string","nullable":true,"format":"uuid","description":"Opaque reason-note id; reading it writes `note.read`."},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Document date set at approval (HYP-06)."},"files":{"type":"array","items":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"sha256Hex":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the original (receipt, AUD-09)."},"sizePlain":{"type":"integer","nullable":true,"minimum":0,"description":"Plaintext size in bytes."},"scanState":{"type":"string","enum":["scanning","available","rejected","failed"],"description":"ADR-0007 version status."}},"required":["versionId","documentId","sha256Hex","sizePlain","scanState"],"description":"One file of a submission (no file names)."},"description":"Files of a `files` submission."}},"required":["id","itemId","kind","decision","baseItemRevision","submittedByPrincipalId","submittedAt","authStrength","decidedBy","decidedAt","reasonCode","noteId","documentDate","files"],"description":"Open submission, when the view shows `submitted`."},"fileRules":{"type":"object","nullable":true,"properties":{"minFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Minimum files to submit (default 1)."},"maxFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Maximum files (default 1, max 50)."},"allowedKinds":{"type":"array","items":{"type":"string","enum":["pdf","image","office","email","any"],"description":"Accepted file kind, checked by content at scan (SEC-08)."},"minItems":1,"maxItems":5,"description":"Accepted kinds, checked by content at scan (SEC-08); `any` covers the rest."},"maxFileBytes":{"type":"integer","minimum":1,"maximum":5368709120,"description":"Per-file size cap in bytes (default 100 MiB, never above 5 GiB, DOC-16)."},"camera":{"type":"boolean","description":"Offer camera capture for images/PDF (HYP-02)."}},"additionalProperties":false,"description":"File rules of a `file` item (INT-F06). Omitted fields fall back to `flowFileRulesDefaults`."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":20000,"description":"`text`: maximum length in characters (default 2000)."},"min":{"type":"number","nullable":true,"description":"`number`: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"`number`: inclusive maximum."},"decimals":{"type":"integer","nullable":true,"minimum":0,"maximum":6,"description":"`number`: allowed decimals."},"unit":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"`number`: unit label (for example \"years\")."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false,"description":"Choice option of a `choice` item."},"maxItems":50,"description":"`choice`: the options."},"multiple":{"type":"boolean","description":"`choice`: allow more than one option."}},"additionalProperties":false,"description":"Answer rules of a `text`, `number`, `date` or `choice` item (INT-F05). Omitted fields fall back to `flowAnswerRulesDefaults`."},"group":{"type":"object","nullable":true,"properties":{"groupId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Group id within the template (E20 `required: \"group\"`)."},"satisfiedBy":{"type":"string","enum":["any_of"],"description":"Only `any_of` in the MVP: one approved option satisfies the group."},"option":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Option code of this item within the group."}},"required":["groupId","satisfiedBy","option"],"additionalProperties":false,"description":"Group of alternatives (E20 `required: \"group\"`, INT-F06)."},"documentType":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"validity":{"type":"object","nullable":true,"properties":{"rule":{"type":"string","enum":["none","max_age","not_expired","covers_years"],"description":"E20 validity rule (HYP-06)."},"months":{"type":"integer","nullable":true,"minimum":0,"maximum":600,"description":"Age or cover window in months."}},"required":["rule","months"],"additionalProperties":false,"description":"E20 validity rule (HYP-06)."},"bsnSensitive":{"type":"boolean"},"idPhotoMustStayVisible":{"type":"boolean"}},"required":["id","flowId","sectionId","position","type","title","instructions","status","revision","required","allowNotApplicable","assignees","visibility","review","dueDate","overdue","skippedAt","lastSubmissionKind","submission","fileRules","answerRules","group","documentType","validity","bsnSensitive","idPhotoMustStayVisible"],"description":"Item view computed from firm-written and guest-owned rows (INT-F07a)."},"description":"Visible item views (INT-F07)."},"createdAt":{"type":"string","format":"date-time"},"sentAt":{"type":"string","nullable":true,"format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","tenantId","roomId","templateVersionId","status","title","message","dueDate","recipients","conditionValues","progress","sections","items","createdAt","sentAt","completedAt"],"description":"Flow instance with the viewer-visible sections, items and progress (INT-F03, INT-F18)."},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"templateId":{"type":"string","nullable":true,"maxLength":100},"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipient":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"email":{"type":"string","maxLength":320,"format":"email"}},"required":["name","email"],"description":"The one person a request is addressed to (client data)."},"portalUrl":{"type":"string","nullable":true,"description":"Always null on the real stack: the link token is only ever in the request e-mail."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group bound to the party; null until the firm binds it."}},"required":["slot","label","groupId"],"additionalProperties":false,"description":"Room-bound party of a request (WF01): applicant slot, display label, room group."},"description":"Named room parties of this request (WF01); empty on legacy rows without a scope."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): bound parties share drafts. False keeps slot-private answers."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance. Null on legacy rows without a period."},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."},"targetFolderId":{"type":"string","nullable":true,"format":"uuid","description":"Room-index folder the approved files go into; null = root."},"targetFolderTitle":{"type":"string","nullable":true},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"overdue":{"type":"boolean"},"authStrength":{"type":"string","nullable":true,"enum":["single","mfa",null],"description":"Strength of the client session that submitted the item (ADR-0013 D1 condition 1)."},"bsnAutoMask":{"type":"boolean","description":"The worker burns every BSN out of a delivered file before approval (ADR-0053)."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number","targetFolderId","targetFolderTitle","submittedAt","overdue","authStrength"],"description":"Request item as the firm sees it."}},"createdAt":{"type":"string","format":"date-time"},"sentAt":{"type":"string","nullable":true,"format":"date-time"},"openedAt":{"type":"string","nullable":true,"format":"date-time"},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"reminders":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"description":"Reminders sent so far (automatic and manual)."},"lastAt":{"type":"string","nullable":true,"format":"date-time"},"nextAt":{"type":"string","nullable":true,"format":"date-time","description":"Next automatic reminder; null when none is due."},"paused":{"type":"boolean"}},"required":["count","lastAt","nextAt","paused"],"description":"Reminder state (ADR-0053)."}},"required":["id","roomId","templateId","title","message","status","dueDate","recipient","portalUrl","parties","joint","periodContext","expiresAt","coverInstructions","displayStatus","progress","sections","items","createdAt","sentAt","openedAt","submittedAt","completedAt","updatedAt"],"description":"Document request (request-flow profile, firm view)."}]}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no send permission).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or flow.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"FLOW_NOT_ACTIVE: the flow was already sent or closed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"422":{"description":"TARGET_INTERNAL or SLOT_GROUP_INVALID.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/flows/{flowId}/close":{"post":{"operationId":"closeFlow","summary":"Close a flow","description":"Closes a sent flow read-only: visible items answer 409 FLOW_NOT_ACTIVE and pending submissions become superseded (INT-F14, ADR-0013 D2). Requires flow.close; writes flow.closed.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"}],"responses":{"200":{"description":"Closed flow.","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"tenantId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"templateVersionId":{"type":"string","nullable":true,"format":"uuid","description":"Frozen template version (null for a blank request)."},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"title":{"type":"string"},"message":{"type":"string","nullable":true,"description":"Message to the client; shown in the portal."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipients":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^(client|all_recipients|organisation|applicant_[1-9][0-9]?)$","description":"Assignee slot: client, all_recipients, organisation or applicant_<n>."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group bound to the slot; null for `organisation`."},"groupLabel":{"type":"string","nullable":true,"description":"Display label of the group (slot label in the review queue)."}},"required":["slot","groupId","groupLabel"],"description":"Slot → room group binding of a flow (INT-F03)."}},"conditionValues":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"enabled":{"type":"boolean"}},"required":["code","enabled"],"description":"Condition state of a flow (INT-F04)."}},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"],"description":"Portal counters."},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"],"description":"Firm counters."},"sections":{"type":"array","items":{"type":"object","properties":{"sectionId":{"type":"string","format":"uuid"},"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["sectionId","done","total"],"description":"Per-section counters (INT-F18)."},"description":"Counters per visible section."}},"required":["client","firm","sections"],"description":"Progress of a flow for one viewer (INT-F18)."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"parentSectionId":{"type":"string","nullable":true,"format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"itemCount":{"type":"integer","minimum":0}},"required":["id","parentSectionId","position","title","instructions","itemCount"],"description":"Section view (INT-F04)."},"description":"Visible sections, numbered for the viewer."},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"flowId":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"type":{"type":"string","enum":["file","text","number","date","choice","acknowledgement","instructions"],"description":"Item type (INT-F05)."},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"status":{"type":"string","enum":["to_do","submitted","in_review","approved","rejected","not_applicable","cancelled"],"description":"Item status (INT-F14)."},"revision":{"type":"integer","minimum":0,"description":"View revision for optimistic concurrency (INT-F14)."},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"assignees":{"type":"array","items":{"type":"string","pattern":"^(client|all_recipients|organisation|applicant_[1-9][0-9]?)$","description":"Assignee slot: client, all_recipients, organisation or applicant_<n>."}},"visibility":{"type":"string","enum":["assignees","internal","shared_on_approval"],"description":"Item visibility (INT-F06, INT-F07)."},"review":{"type":"string","enum":["required","none"],"description":"Review mode: `required` gates on a professional decision, `none` is accepted on submit."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"overdue":{"type":"boolean","description":"Derived: due date passed and status `to_do` or `rejected`."},"skippedAt":{"type":"string","nullable":true,"format":"date-time","description":"Latest skip marker (INT-F12)."},"lastSubmissionKind":{"type":"string","nullable":true,"enum":["files","answer","acknowledgement","not_applicable",null],"description":"Submission kind (INT-F11, INT-F12)."},"submission":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"itemId":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["files","answer","acknowledgement","not_applicable"],"description":"Submission kind (INT-F11, INT-F12)."},"decision":{"type":"string","enum":["pending","approved","rejected","superseded"],"description":"Submission decision (ADR-0013 D2, INT-F16)."},"baseItemRevision":{"type":"integer","minimum":0},"submittedByPrincipalId":{"type":"string","nullable":true,"format":"uuid"},"submittedAt":{"type":"string","format":"date-time"},"authStrength":{"type":"string","enum":["single","mfa"],"description":"Recorded auth strength (ADR-0013 D1)."},"decidedBy":{"type":"string","nullable":true,"format":"uuid"},"decidedAt":{"type":"string","nullable":true,"format":"date-time"},"reasonCode":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Decision reason code; text lives in the encrypted note."},"noteId":{"type":"string","nullable":true,"format":"uuid","description":"Opaque reason-note id; reading it writes `note.read`."},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Document date set at approval (HYP-06)."},"files":{"type":"array","items":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"sha256Hex":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the original (receipt, AUD-09)."},"sizePlain":{"type":"integer","nullable":true,"minimum":0,"description":"Plaintext size in bytes."},"scanState":{"type":"string","enum":["scanning","available","rejected","failed"],"description":"ADR-0007 version status."}},"required":["versionId","documentId","sha256Hex","sizePlain","scanState"],"description":"One file of a submission (no file names)."},"description":"Files of a `files` submission."}},"required":["id","itemId","kind","decision","baseItemRevision","submittedByPrincipalId","submittedAt","authStrength","decidedBy","decidedAt","reasonCode","noteId","documentDate","files"],"description":"Open submission, when the view shows `submitted`."},"fileRules":{"type":"object","nullable":true,"properties":{"minFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Minimum files to submit (default 1)."},"maxFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Maximum files (default 1, max 50)."},"allowedKinds":{"type":"array","items":{"type":"string","enum":["pdf","image","office","email","any"],"description":"Accepted file kind, checked by content at scan (SEC-08)."},"minItems":1,"maxItems":5,"description":"Accepted kinds, checked by content at scan (SEC-08); `any` covers the rest."},"maxFileBytes":{"type":"integer","minimum":1,"maximum":5368709120,"description":"Per-file size cap in bytes (default 100 MiB, never above 5 GiB, DOC-16)."},"camera":{"type":"boolean","description":"Offer camera capture for images/PDF (HYP-02)."}},"additionalProperties":false,"description":"File rules of a `file` item (INT-F06). Omitted fields fall back to `flowFileRulesDefaults`."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":20000,"description":"`text`: maximum length in characters (default 2000)."},"min":{"type":"number","nullable":true,"description":"`number`: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"`number`: inclusive maximum."},"decimals":{"type":"integer","nullable":true,"minimum":0,"maximum":6,"description":"`number`: allowed decimals."},"unit":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"`number`: unit label (for example \"years\")."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false,"description":"Choice option of a `choice` item."},"maxItems":50,"description":"`choice`: the options."},"multiple":{"type":"boolean","description":"`choice`: allow more than one option."}},"additionalProperties":false,"description":"Answer rules of a `text`, `number`, `date` or `choice` item (INT-F05). Omitted fields fall back to `flowAnswerRulesDefaults`."},"group":{"type":"object","nullable":true,"properties":{"groupId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Group id within the template (E20 `required: \"group\"`)."},"satisfiedBy":{"type":"string","enum":["any_of"],"description":"Only `any_of` in the MVP: one approved option satisfies the group."},"option":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Option code of this item within the group."}},"required":["groupId","satisfiedBy","option"],"additionalProperties":false,"description":"Group of alternatives (E20 `required: \"group\"`, INT-F06)."},"documentType":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"validity":{"type":"object","nullable":true,"properties":{"rule":{"type":"string","enum":["none","max_age","not_expired","covers_years"],"description":"E20 validity rule (HYP-06)."},"months":{"type":"integer","nullable":true,"minimum":0,"maximum":600,"description":"Age or cover window in months."}},"required":["rule","months"],"additionalProperties":false,"description":"E20 validity rule (HYP-06)."},"bsnSensitive":{"type":"boolean"},"idPhotoMustStayVisible":{"type":"boolean"}},"required":["id","flowId","sectionId","position","type","title","instructions","status","revision","required","allowNotApplicable","assignees","visibility","review","dueDate","overdue","skippedAt","lastSubmissionKind","submission","fileRules","answerRules","group","documentType","validity","bsnSensitive","idPhotoMustStayVisible"],"description":"Item view computed from firm-written and guest-owned rows (INT-F07a)."},"description":"Visible item views (INT-F07)."},"createdAt":{"type":"string","format":"date-time"},"sentAt":{"type":"string","nullable":true,"format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","tenantId","roomId","templateVersionId","status","title","message","dueDate","recipients","conditionValues","progress","sections","items","createdAt","sentAt","completedAt"],"description":"Flow instance with the viewer-visible sections, items and progress (INT-F03, INT-F18)."},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"templateId":{"type":"string","nullable":true,"maxLength":100},"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipient":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"email":{"type":"string","maxLength":320,"format":"email"}},"required":["name","email"],"description":"The one person a request is addressed to (client data)."},"portalUrl":{"type":"string","nullable":true,"description":"Always null on the real stack: the link token is only ever in the request e-mail."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group bound to the party; null until the firm binds it."}},"required":["slot","label","groupId"],"additionalProperties":false,"description":"Room-bound party of a request (WF01): applicant slot, display label, room group."},"description":"Named room parties of this request (WF01); empty on legacy rows without a scope."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): bound parties share drafts. False keeps slot-private answers."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance. Null on legacy rows without a period."},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."},"targetFolderId":{"type":"string","nullable":true,"format":"uuid","description":"Room-index folder the approved files go into; null = root."},"targetFolderTitle":{"type":"string","nullable":true},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"overdue":{"type":"boolean"},"authStrength":{"type":"string","nullable":true,"enum":["single","mfa",null],"description":"Strength of the client session that submitted the item (ADR-0013 D1 condition 1)."},"bsnAutoMask":{"type":"boolean","description":"The worker burns every BSN out of a delivered file before approval (ADR-0053)."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number","targetFolderId","targetFolderTitle","submittedAt","overdue","authStrength"],"description":"Request item as the firm sees it."}},"createdAt":{"type":"string","format":"date-time"},"sentAt":{"type":"string","nullable":true,"format":"date-time"},"openedAt":{"type":"string","nullable":true,"format":"date-time"},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"reminders":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"description":"Reminders sent so far (automatic and manual)."},"lastAt":{"type":"string","nullable":true,"format":"date-time"},"nextAt":{"type":"string","nullable":true,"format":"date-time","description":"Next automatic reminder; null when none is due."},"paused":{"type":"boolean"}},"required":["count","lastAt","nextAt","paused"],"description":"Reminder state (ADR-0053)."}},"required":["id","roomId","templateId","title","message","status","dueDate","recipient","portalUrl","parties","joint","periodContext","expiresAt","coverInstructions","displayStatus","progress","sections","items","createdAt","sentAt","openedAt","submittedAt","completedAt","updatedAt"],"description":"Document request (request-flow profile, firm view)."}]}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no close permission).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or flow.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"FLOW_NOT_ACTIVE: the flow is not sent.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/flows/{flowId}/items":{"get":{"operationId":"listFlowItems","summary":"List the item views of a flow","description":"Item views (INT-F07a) the caller may see, in section order. Clients get only their assigned, shared-on-approval or instructions items; anything else is absent (INT-F07). Requires flow.read. Navigation read: no audit event.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"}],"responses":{"200":{"description":"Item views.","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"flowId":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"type":{"type":"string","enum":["file","text","number","date","choice","acknowledgement","instructions"],"description":"Item type (INT-F05)."},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"status":{"type":"string","enum":["to_do","submitted","in_review","approved","rejected","not_applicable","cancelled"],"description":"Item status (INT-F14)."},"revision":{"type":"integer","minimum":0,"description":"View revision for optimistic concurrency (INT-F14)."},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"assignees":{"type":"array","items":{"type":"string","pattern":"^(client|all_recipients|organisation|applicant_[1-9][0-9]?)$","description":"Assignee slot: client, all_recipients, organisation or applicant_<n>."}},"visibility":{"type":"string","enum":["assignees","internal","shared_on_approval"],"description":"Item visibility (INT-F06, INT-F07)."},"review":{"type":"string","enum":["required","none"],"description":"Review mode: `required` gates on a professional decision, `none` is accepted on submit."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"overdue":{"type":"boolean","description":"Derived: due date passed and status `to_do` or `rejected`."},"skippedAt":{"type":"string","nullable":true,"format":"date-time","description":"Latest skip marker (INT-F12)."},"lastSubmissionKind":{"type":"string","nullable":true,"enum":["files","answer","acknowledgement","not_applicable",null],"description":"Submission kind (INT-F11, INT-F12)."},"submission":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"itemId":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["files","answer","acknowledgement","not_applicable"],"description":"Submission kind (INT-F11, INT-F12)."},"decision":{"type":"string","enum":["pending","approved","rejected","superseded"],"description":"Submission decision (ADR-0013 D2, INT-F16)."},"baseItemRevision":{"type":"integer","minimum":0},"submittedByPrincipalId":{"type":"string","nullable":true,"format":"uuid"},"submittedAt":{"type":"string","format":"date-time"},"authStrength":{"type":"string","enum":["single","mfa"],"description":"Recorded auth strength (ADR-0013 D1)."},"decidedBy":{"type":"string","nullable":true,"format":"uuid"},"decidedAt":{"type":"string","nullable":true,"format":"date-time"},"reasonCode":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Decision reason code; text lives in the encrypted note."},"noteId":{"type":"string","nullable":true,"format":"uuid","description":"Opaque reason-note id; reading it writes `note.read`."},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Document date set at approval (HYP-06)."},"files":{"type":"array","items":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"sha256Hex":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the original (receipt, AUD-09)."},"sizePlain":{"type":"integer","nullable":true,"minimum":0,"description":"Plaintext size in bytes."},"scanState":{"type":"string","enum":["scanning","available","rejected","failed"],"description":"ADR-0007 version status."}},"required":["versionId","documentId","sha256Hex","sizePlain","scanState"],"description":"One file of a submission (no file names)."},"description":"Files of a `files` submission."}},"required":["id","itemId","kind","decision","baseItemRevision","submittedByPrincipalId","submittedAt","authStrength","decidedBy","decidedAt","reasonCode","noteId","documentDate","files"],"description":"Open submission, when the view shows `submitted`."},"fileRules":{"type":"object","nullable":true,"properties":{"minFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Minimum files to submit (default 1)."},"maxFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Maximum files (default 1, max 50)."},"allowedKinds":{"type":"array","items":{"type":"string","enum":["pdf","image","office","email","any"],"description":"Accepted file kind, checked by content at scan (SEC-08)."},"minItems":1,"maxItems":5,"description":"Accepted kinds, checked by content at scan (SEC-08); `any` covers the rest."},"maxFileBytes":{"type":"integer","minimum":1,"maximum":5368709120,"description":"Per-file size cap in bytes (default 100 MiB, never above 5 GiB, DOC-16)."},"camera":{"type":"boolean","description":"Offer camera capture for images/PDF (HYP-02)."}},"additionalProperties":false,"description":"File rules of a `file` item (INT-F06). Omitted fields fall back to `flowFileRulesDefaults`."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":20000,"description":"`text`: maximum length in characters (default 2000)."},"min":{"type":"number","nullable":true,"description":"`number`: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"`number`: inclusive maximum."},"decimals":{"type":"integer","nullable":true,"minimum":0,"maximum":6,"description":"`number`: allowed decimals."},"unit":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"`number`: unit label (for example \"years\")."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false,"description":"Choice option of a `choice` item."},"maxItems":50,"description":"`choice`: the options."},"multiple":{"type":"boolean","description":"`choice`: allow more than one option."}},"additionalProperties":false,"description":"Answer rules of a `text`, `number`, `date` or `choice` item (INT-F05). Omitted fields fall back to `flowAnswerRulesDefaults`."},"group":{"type":"object","nullable":true,"properties":{"groupId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Group id within the template (E20 `required: \"group\"`)."},"satisfiedBy":{"type":"string","enum":["any_of"],"description":"Only `any_of` in the MVP: one approved option satisfies the group."},"option":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Option code of this item within the group."}},"required":["groupId","satisfiedBy","option"],"additionalProperties":false,"description":"Group of alternatives (E20 `required: \"group\"`, INT-F06)."},"documentType":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"validity":{"type":"object","nullable":true,"properties":{"rule":{"type":"string","enum":["none","max_age","not_expired","covers_years"],"description":"E20 validity rule (HYP-06)."},"months":{"type":"integer","nullable":true,"minimum":0,"maximum":600,"description":"Age or cover window in months."}},"required":["rule","months"],"additionalProperties":false,"description":"E20 validity rule (HYP-06)."},"bsnSensitive":{"type":"boolean"},"idPhotoMustStayVisible":{"type":"boolean"}},"required":["id","flowId","sectionId","position","type","title","instructions","status","revision","required","allowNotApplicable","assignees","visibility","review","dueDate","overdue","skippedAt","lastSubmissionKind","submission","fileRules","answerRules","group","documentType","validity","bsnSensitive","idPhotoMustStayVisible"],"description":"Item view computed from firm-written and guest-owned rows (INT-F07a)."}}},"required":["items"],"description":"Item views visible to the caller, in section order (INT-F07, INT-F09)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or flow, or no access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/flows/{flowId}/items/{itemId}/submissions":{"post":{"operationId":"submitFlowItem","summary":"Submit an item for review","description":"Client submit (INT-F11, INT-F12): validates the submission against the item (same codes as flow-rules.mjs `validateSubmission`), inserts a guest-owned pending submission and never updates the firm-created row. A stale revision answers 409 REVISION_CONFLICT; a submission while the upload is still running answers 409 UPLOAD_IN_PROGRESS. Writes flow_item.submitted with the recorded auth strength, plus flow_item.approved for review=none.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"revision":{"type":"integer","minimum":0,"description":"Item view revision the client saw (INT-F14)."},"kind":{"type":"string","enum":["files","answer","acknowledgement","not_applicable"],"description":"Submission kind (INT-F11, INT-F12)."},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}}],"description":"Answer value for an `answer` submission."},"fileVersionIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":50,"description":"Draft file versions of a `files` submission."},"statementSha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"`acknowledgement`: SHA-256 of the template statement text."},"reasonCode":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"`not_applicable`: reason code (INT-F12)."},"note":{"type":"string","maxLength":4000,"description":"Optional note; stored encrypted (`other` requires one)."}},"required":["revision","kind"],"additionalProperties":false,"description":"Client submit of one item (INT-F11, INT-F12)."}}}},"responses":{"201":{"description":"Submission recorded.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"itemId":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["files","answer","acknowledgement","not_applicable"],"description":"Submission kind (INT-F11, INT-F12)."},"decision":{"type":"string","enum":["pending","approved","rejected","superseded"],"description":"Submission decision (ADR-0013 D2, INT-F16)."},"baseItemRevision":{"type":"integer","minimum":0},"submittedByPrincipalId":{"type":"string","nullable":true,"format":"uuid"},"submittedAt":{"type":"string","format":"date-time"},"authStrength":{"type":"string","enum":["single","mfa"],"description":"Recorded auth strength (ADR-0013 D1)."},"decidedBy":{"type":"string","nullable":true,"format":"uuid"},"decidedAt":{"type":"string","nullable":true,"format":"date-time"},"reasonCode":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Decision reason code; text lives in the encrypted note."},"noteId":{"type":"string","nullable":true,"format":"uuid","description":"Opaque reason-note id; reading it writes `note.read`."},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Document date set at approval (HYP-06)."},"files":{"type":"array","items":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"sha256Hex":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the original (receipt, AUD-09)."},"sizePlain":{"type":"integer","nullable":true,"minimum":0,"description":"Plaintext size in bytes."},"scanState":{"type":"string","enum":["scanning","available","rejected","failed"],"description":"ADR-0007 version status."}},"required":["versionId","documentId","sha256Hex","sizePlain","scanState"],"description":"One file of a submission (no file names)."},"description":"Files of a `files` submission."}},"required":["id","itemId","kind","decision","baseItemRevision","submittedByPrincipalId","submittedAt","authStrength","decidedBy","decidedAt","reasonCode","noteId","documentDate","files"],"description":"Submission and its decision (INT-F11, INT-F16)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"ACTOR_NOT_ALLOWED for a visible but unassigned item.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"NOT_FOUND: the item is invisible to the client (no existence oracle, INT-F14).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"FLOW_NOT_ACTIVE, REVISION_CONFLICT, ITEM_STATE_CONFLICT or UPLOAD_IN_PROGRESS.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"422":{"description":"Submission validation code (INT-F05, INT-F06, INT-F12).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/flows/{flowId}/items/{itemId}/skip":{"post":{"operationId":"skipFlowItem","summary":"Skip an item for now","description":"Client skip (INT-F12): inserts a guest-owned skip marker, keeps status and revision and stays in reminders. Writes flow_item.skipped. Invisible items answer 404 (INT-F14 error order).","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"revision":{"type":"integer","minimum":0,"description":"Item view revision; a skip never raises it (INT-F12)."}},"required":["revision"],"additionalProperties":false,"description":"Skip an item for now (INT-F12)."}}}},"responses":{"200":{"description":"Updated item view (skippedAt set).","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"flowId":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"type":{"type":"string","enum":["file","text","number","date","choice","acknowledgement","instructions"],"description":"Item type (INT-F05)."},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"status":{"type":"string","enum":["to_do","submitted","in_review","approved","rejected","not_applicable","cancelled"],"description":"Item status (INT-F14)."},"revision":{"type":"integer","minimum":0,"description":"View revision for optimistic concurrency (INT-F14)."},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"assignees":{"type":"array","items":{"type":"string","pattern":"^(client|all_recipients|organisation|applicant_[1-9][0-9]?)$","description":"Assignee slot: client, all_recipients, organisation or applicant_<n>."}},"visibility":{"type":"string","enum":["assignees","internal","shared_on_approval"],"description":"Item visibility (INT-F06, INT-F07)."},"review":{"type":"string","enum":["required","none"],"description":"Review mode: `required` gates on a professional decision, `none` is accepted on submit."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"overdue":{"type":"boolean","description":"Derived: due date passed and status `to_do` or `rejected`."},"skippedAt":{"type":"string","nullable":true,"format":"date-time","description":"Latest skip marker (INT-F12)."},"lastSubmissionKind":{"type":"string","nullable":true,"enum":["files","answer","acknowledgement","not_applicable",null],"description":"Submission kind (INT-F11, INT-F12)."},"submission":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"itemId":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["files","answer","acknowledgement","not_applicable"],"description":"Submission kind (INT-F11, INT-F12)."},"decision":{"type":"string","enum":["pending","approved","rejected","superseded"],"description":"Submission decision (ADR-0013 D2, INT-F16)."},"baseItemRevision":{"type":"integer","minimum":0},"submittedByPrincipalId":{"type":"string","nullable":true,"format":"uuid"},"submittedAt":{"type":"string","format":"date-time"},"authStrength":{"type":"string","enum":["single","mfa"],"description":"Recorded auth strength (ADR-0013 D1)."},"decidedBy":{"type":"string","nullable":true,"format":"uuid"},"decidedAt":{"type":"string","nullable":true,"format":"date-time"},"reasonCode":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Decision reason code; text lives in the encrypted note."},"noteId":{"type":"string","nullable":true,"format":"uuid","description":"Opaque reason-note id; reading it writes `note.read`."},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Document date set at approval (HYP-06)."},"files":{"type":"array","items":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"sha256Hex":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the original (receipt, AUD-09)."},"sizePlain":{"type":"integer","nullable":true,"minimum":0,"description":"Plaintext size in bytes."},"scanState":{"type":"string","enum":["scanning","available","rejected","failed"],"description":"ADR-0007 version status."}},"required":["versionId","documentId","sha256Hex","sizePlain","scanState"],"description":"One file of a submission (no file names)."},"description":"Files of a `files` submission."}},"required":["id","itemId","kind","decision","baseItemRevision","submittedByPrincipalId","submittedAt","authStrength","decidedBy","decidedAt","reasonCode","noteId","documentDate","files"],"description":"Open submission, when the view shows `submitted`."},"fileRules":{"type":"object","nullable":true,"properties":{"minFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Minimum files to submit (default 1)."},"maxFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Maximum files (default 1, max 50)."},"allowedKinds":{"type":"array","items":{"type":"string","enum":["pdf","image","office","email","any"],"description":"Accepted file kind, checked by content at scan (SEC-08)."},"minItems":1,"maxItems":5,"description":"Accepted kinds, checked by content at scan (SEC-08); `any` covers the rest."},"maxFileBytes":{"type":"integer","minimum":1,"maximum":5368709120,"description":"Per-file size cap in bytes (default 100 MiB, never above 5 GiB, DOC-16)."},"camera":{"type":"boolean","description":"Offer camera capture for images/PDF (HYP-02)."}},"additionalProperties":false,"description":"File rules of a `file` item (INT-F06). Omitted fields fall back to `flowFileRulesDefaults`."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":20000,"description":"`text`: maximum length in characters (default 2000)."},"min":{"type":"number","nullable":true,"description":"`number`: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"`number`: inclusive maximum."},"decimals":{"type":"integer","nullable":true,"minimum":0,"maximum":6,"description":"`number`: allowed decimals."},"unit":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"`number`: unit label (for example \"years\")."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false,"description":"Choice option of a `choice` item."},"maxItems":50,"description":"`choice`: the options."},"multiple":{"type":"boolean","description":"`choice`: allow more than one option."}},"additionalProperties":false,"description":"Answer rules of a `text`, `number`, `date` or `choice` item (INT-F05). Omitted fields fall back to `flowAnswerRulesDefaults`."},"group":{"type":"object","nullable":true,"properties":{"groupId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Group id within the template (E20 `required: \"group\"`)."},"satisfiedBy":{"type":"string","enum":["any_of"],"description":"Only `any_of` in the MVP: one approved option satisfies the group."},"option":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Option code of this item within the group."}},"required":["groupId","satisfiedBy","option"],"additionalProperties":false,"description":"Group of alternatives (E20 `required: \"group\"`, INT-F06)."},"documentType":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"validity":{"type":"object","nullable":true,"properties":{"rule":{"type":"string","enum":["none","max_age","not_expired","covers_years"],"description":"E20 validity rule (HYP-06)."},"months":{"type":"integer","nullable":true,"minimum":0,"maximum":600,"description":"Age or cover window in months."}},"required":["rule","months"],"additionalProperties":false,"description":"E20 validity rule (HYP-06)."},"bsnSensitive":{"type":"boolean"},"idPhotoMustStayVisible":{"type":"boolean"}},"required":["id","flowId","sectionId","position","type","title","instructions","status","revision","required","allowNotApplicable","assignees","visibility","review","dueDate","overdue","skippedAt","lastSubmissionKind","submission","fileRules","answerRules","group","documentType","validity","bsnSensitive","idPhotoMustStayVisible"],"description":"Item view computed from firm-written and guest-owned rows (INT-F07a)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"ACTOR_NOT_ALLOWED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"NOT_FOUND: the item is invisible to the client.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"FLOW_NOT_ACTIVE or ITEM_STATE_CONFLICT.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/flows/{flowId}/items/{itemId}/draft-answer":{"put":{"operationId":"saveFlowAnswerDraft","summary":"Save a draft answer","description":"Encrypted draft answer readable only by its author (INT-F11). Each save writes flow_answer.draft_saved; each read-back writes flow_answer.read (ADR-0013 D2). Invisible items answer 404.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}}],"description":"Draft value, readable only by its author."}},"required":["value"],"additionalProperties":false,"description":"Save a draft answer (INT-F11)."}}}},"responses":{"200":{"description":"Stored draft answer.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"itemId":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["file","text","number","date","choice","acknowledgement","instructions"],"description":"Item type (INT-F05)."},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}}],"description":"Answer value: text, number, ISO date or choice codes (client data)."},"draft":{"type":"boolean","description":"True for an author-only draft (submission_id NULL)."},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","itemId","type","value","draft","updatedAt"],"description":"Answer value (returned by the audited read only, ADR-0013 D2)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"ACTOR_NOT_ALLOWED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"NOT_FOUND: the item is invisible to the client.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"FLOW_NOT_ACTIVE or REVISION_CONFLICT.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"422":{"description":"Answer validation code.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/flows/{flowId}/items/{itemId}/answers/{answerId}":{"get":{"operationId":"readFlowAnswer","summary":"Read an answer value","description":"Returns an answer value (draft or submitted) to the author, an assignee of the item or a professional with read access (INT-F11, ADR-0013 D2). Every read writes flow_answer.read before the first byte (fail closed with 503). Other principals get 404.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"answerId","in":"path"}],"responses":{"200":{"description":"Answer value.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"itemId":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["file","text","number","date","choice","acknowledgement","instructions"],"description":"Item type (INT-F05)."},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"array","items":{"type":"string"}}],"description":"Answer value: text, number, ISO date or choice codes (client data)."},"draft":{"type":"boolean","description":"True for an author-only draft (submission_id NULL)."},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","itemId","type","value","draft","updatedAt"],"description":"Answer value (returned by the audited read only, ADR-0013 D2)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"STEP_UP_REQUIRED for submitted answers and others' drafts.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"NOT_FOUND: the item or answer is invisible to the caller.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"Fail closed: the flow_answer.read audit write failed, so no answer is served (ADR-0006 D5).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/flows/{flowId}/items/{itemId}/draft-files":{"post":{"operationId":"attachFlowDraftFile","summary":"Attach an uploaded version as a draft file","description":"Registers a tus-uploaded version as a draft file of the item (INT-F11). The version follows the ADR-0007 statuses unchanged and stays behind the DOC-09 gate until approval. Writes flow_item.changed.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","description":"Uploaded document version (created through tus, ADR-0007)."}},"required":["versionId"],"additionalProperties":false,"description":"Attach an uploaded version as a draft file (INT-F11)."}}}},"responses":{"201":{"description":"Updated item view with the draft file.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"flowId":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"type":{"type":"string","enum":["file","text","number","date","choice","acknowledgement","instructions"],"description":"Item type (INT-F05)."},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"status":{"type":"string","enum":["to_do","submitted","in_review","approved","rejected","not_applicable","cancelled"],"description":"Item status (INT-F14)."},"revision":{"type":"integer","minimum":0,"description":"View revision for optimistic concurrency (INT-F14)."},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"assignees":{"type":"array","items":{"type":"string","pattern":"^(client|all_recipients|organisation|applicant_[1-9][0-9]?)$","description":"Assignee slot: client, all_recipients, organisation or applicant_<n>."}},"visibility":{"type":"string","enum":["assignees","internal","shared_on_approval"],"description":"Item visibility (INT-F06, INT-F07)."},"review":{"type":"string","enum":["required","none"],"description":"Review mode: `required` gates on a professional decision, `none` is accepted on submit."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"overdue":{"type":"boolean","description":"Derived: due date passed and status `to_do` or `rejected`."},"skippedAt":{"type":"string","nullable":true,"format":"date-time","description":"Latest skip marker (INT-F12)."},"lastSubmissionKind":{"type":"string","nullable":true,"enum":["files","answer","acknowledgement","not_applicable",null],"description":"Submission kind (INT-F11, INT-F12)."},"submission":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"itemId":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["files","answer","acknowledgement","not_applicable"],"description":"Submission kind (INT-F11, INT-F12)."},"decision":{"type":"string","enum":["pending","approved","rejected","superseded"],"description":"Submission decision (ADR-0013 D2, INT-F16)."},"baseItemRevision":{"type":"integer","minimum":0},"submittedByPrincipalId":{"type":"string","nullable":true,"format":"uuid"},"submittedAt":{"type":"string","format":"date-time"},"authStrength":{"type":"string","enum":["single","mfa"],"description":"Recorded auth strength (ADR-0013 D1)."},"decidedBy":{"type":"string","nullable":true,"format":"uuid"},"decidedAt":{"type":"string","nullable":true,"format":"date-time"},"reasonCode":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Decision reason code; text lives in the encrypted note."},"noteId":{"type":"string","nullable":true,"format":"uuid","description":"Opaque reason-note id; reading it writes `note.read`."},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Document date set at approval (HYP-06)."},"files":{"type":"array","items":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"sha256Hex":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the original (receipt, AUD-09)."},"sizePlain":{"type":"integer","nullable":true,"minimum":0,"description":"Plaintext size in bytes."},"scanState":{"type":"string","enum":["scanning","available","rejected","failed"],"description":"ADR-0007 version status."}},"required":["versionId","documentId","sha256Hex","sizePlain","scanState"],"description":"One file of a submission (no file names)."},"description":"Files of a `files` submission."}},"required":["id","itemId","kind","decision","baseItemRevision","submittedByPrincipalId","submittedAt","authStrength","decidedBy","decidedAt","reasonCode","noteId","documentDate","files"],"description":"Open submission, when the view shows `submitted`."},"fileRules":{"type":"object","nullable":true,"properties":{"minFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Minimum files to submit (default 1)."},"maxFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Maximum files (default 1, max 50)."},"allowedKinds":{"type":"array","items":{"type":"string","enum":["pdf","image","office","email","any"],"description":"Accepted file kind, checked by content at scan (SEC-08)."},"minItems":1,"maxItems":5,"description":"Accepted kinds, checked by content at scan (SEC-08); `any` covers the rest."},"maxFileBytes":{"type":"integer","minimum":1,"maximum":5368709120,"description":"Per-file size cap in bytes (default 100 MiB, never above 5 GiB, DOC-16)."},"camera":{"type":"boolean","description":"Offer camera capture for images/PDF (HYP-02)."}},"additionalProperties":false,"description":"File rules of a `file` item (INT-F06). Omitted fields fall back to `flowFileRulesDefaults`."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":20000,"description":"`text`: maximum length in characters (default 2000)."},"min":{"type":"number","nullable":true,"description":"`number`: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"`number`: inclusive maximum."},"decimals":{"type":"integer","nullable":true,"minimum":0,"maximum":6,"description":"`number`: allowed decimals."},"unit":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"`number`: unit label (for example \"years\")."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false,"description":"Choice option of a `choice` item."},"maxItems":50,"description":"`choice`: the options."},"multiple":{"type":"boolean","description":"`choice`: allow more than one option."}},"additionalProperties":false,"description":"Answer rules of a `text`, `number`, `date` or `choice` item (INT-F05). Omitted fields fall back to `flowAnswerRulesDefaults`."},"group":{"type":"object","nullable":true,"properties":{"groupId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Group id within the template (E20 `required: \"group\"`)."},"satisfiedBy":{"type":"string","enum":["any_of"],"description":"Only `any_of` in the MVP: one approved option satisfies the group."},"option":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Option code of this item within the group."}},"required":["groupId","satisfiedBy","option"],"additionalProperties":false,"description":"Group of alternatives (E20 `required: \"group\"`, INT-F06)."},"documentType":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"validity":{"type":"object","nullable":true,"properties":{"rule":{"type":"string","enum":["none","max_age","not_expired","covers_years"],"description":"E20 validity rule (HYP-06)."},"months":{"type":"integer","nullable":true,"minimum":0,"maximum":600,"description":"Age or cover window in months."}},"required":["rule","months"],"additionalProperties":false,"description":"E20 validity rule (HYP-06)."},"bsnSensitive":{"type":"boolean"},"idPhotoMustStayVisible":{"type":"boolean"}},"required":["id","flowId","sectionId","position","type","title","instructions","status","revision","required","allowNotApplicable","assignees","visibility","review","dueDate","overdue","skippedAt","lastSubmissionKind","submission","fileRules","answerRules","group","documentType","validity","bsnSensitive","idPhotoMustStayVisible"],"description":"Item view computed from firm-written and guest-owned rows (INT-F07a)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"ACTOR_NOT_ALLOWED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"NOT_FOUND: the item is invisible to the client.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"FLOW_NOT_ACTIVE or REVISION_CONFLICT.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/flows/{flowId}/items/{itemId}/draft-files/{versionId}":{"delete":{"operationId":"removeFlowDraftFile","summary":"Remove a draft file before submitting","description":"Sets flow_draft_file.removed_at once (the only guest-updatable column of that guest-owned row) and never changes the document version (INT-F11, INT-F07a). Writes flow_item.draft_file_removed. Removed drafts are listed nowhere.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"versionId","in":"path"}],"responses":{"204":{"description":"Draft file removed."},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"ACTOR_NOT_ALLOWED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"NOT_FOUND: the item or version is invisible to the client.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"FLOW_NOT_ACTIVE or ITEM_STATE_CONFLICT.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/flows/{flowId}/items/{itemId}/review":{"post":{"operationId":"reviewFlowItem","summary":"Start, approve, reject, re-request, waive, cancel or reopen an item","description":"Professional review verdict (INT-F14, INT-F16): start_review, approve, reject, rerequest, waive, cancel or reopen_cancelled. The caller's revision must match the item view; a stale revision answers 409 REVISION_CONFLICT and the first failing check decides the error (INT-F14 error order). Reason codes come from the generic list plus the template extensions; `other` requires a note. Writes flow_item.review_started|approved|rejected|rerequested|waived, plus document_version.approved|rejected for files.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"revision":{"type":"integer","minimum":0,"description":"Item view revision the reviewer saw (INT-F14)."},"action":{"type":"string","enum":["start_review","approve","reject","rerequest","waive","cancel","reopen_cancelled"],"description":"Review transition of an item (INT-F14)."},"reasonCode":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Required for reject/rerequest/waive/cancel (INT-F16)."},"note":{"type":"string","maxLength":4000,"description":"Optional note; encrypted, `other` requires one."},"documentDate":{"type":"string","format":"date","description":"Approval document date when the item has a validity rule."}},"required":["revision","action"],"additionalProperties":false,"description":"Review verdict on one item (INT-F14, INT-F16)."},{"type":"object","properties":{"action":{"type":"string","enum":["approve"]}},"required":["action"],"additionalProperties":false},{"type":"object","properties":{"action":{"type":"string","enum":["reject"]},"reasonCode":{"type":"string","enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other"],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000}},"required":["action","reasonCode","note"],"additionalProperties":false}]}}}},"responses":{"200":{"description":"Updated item view.","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"flowId":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"type":{"type":"string","enum":["file","text","number","date","choice","acknowledgement","instructions"],"description":"Item type (INT-F05)."},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"status":{"type":"string","enum":["to_do","submitted","in_review","approved","rejected","not_applicable","cancelled"],"description":"Item status (INT-F14)."},"revision":{"type":"integer","minimum":0,"description":"View revision for optimistic concurrency (INT-F14)."},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"assignees":{"type":"array","items":{"type":"string","pattern":"^(client|all_recipients|organisation|applicant_[1-9][0-9]?)$","description":"Assignee slot: client, all_recipients, organisation or applicant_<n>."}},"visibility":{"type":"string","enum":["assignees","internal","shared_on_approval"],"description":"Item visibility (INT-F06, INT-F07)."},"review":{"type":"string","enum":["required","none"],"description":"Review mode: `required` gates on a professional decision, `none` is accepted on submit."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"overdue":{"type":"boolean","description":"Derived: due date passed and status `to_do` or `rejected`."},"skippedAt":{"type":"string","nullable":true,"format":"date-time","description":"Latest skip marker (INT-F12)."},"lastSubmissionKind":{"type":"string","nullable":true,"enum":["files","answer","acknowledgement","not_applicable",null],"description":"Submission kind (INT-F11, INT-F12)."},"submission":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"itemId":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["files","answer","acknowledgement","not_applicable"],"description":"Submission kind (INT-F11, INT-F12)."},"decision":{"type":"string","enum":["pending","approved","rejected","superseded"],"description":"Submission decision (ADR-0013 D2, INT-F16)."},"baseItemRevision":{"type":"integer","minimum":0},"submittedByPrincipalId":{"type":"string","nullable":true,"format":"uuid"},"submittedAt":{"type":"string","format":"date-time"},"authStrength":{"type":"string","enum":["single","mfa"],"description":"Recorded auth strength (ADR-0013 D1)."},"decidedBy":{"type":"string","nullable":true,"format":"uuid"},"decidedAt":{"type":"string","nullable":true,"format":"date-time"},"reasonCode":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Decision reason code; text lives in the encrypted note."},"noteId":{"type":"string","nullable":true,"format":"uuid","description":"Opaque reason-note id; reading it writes `note.read`."},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Document date set at approval (HYP-06)."},"files":{"type":"array","items":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"sha256Hex":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the original (receipt, AUD-09)."},"sizePlain":{"type":"integer","nullable":true,"minimum":0,"description":"Plaintext size in bytes."},"scanState":{"type":"string","enum":["scanning","available","rejected","failed"],"description":"ADR-0007 version status."}},"required":["versionId","documentId","sha256Hex","sizePlain","scanState"],"description":"One file of a submission (no file names)."},"description":"Files of a `files` submission."}},"required":["id","itemId","kind","decision","baseItemRevision","submittedByPrincipalId","submittedAt","authStrength","decidedBy","decidedAt","reasonCode","noteId","documentDate","files"],"description":"Open submission, when the view shows `submitted`."},"fileRules":{"type":"object","nullable":true,"properties":{"minFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Minimum files to submit (default 1)."},"maxFiles":{"type":"integer","minimum":1,"maximum":50,"description":"Maximum files (default 1, max 50)."},"allowedKinds":{"type":"array","items":{"type":"string","enum":["pdf","image","office","email","any"],"description":"Accepted file kind, checked by content at scan (SEC-08)."},"minItems":1,"maxItems":5,"description":"Accepted kinds, checked by content at scan (SEC-08); `any` covers the rest."},"maxFileBytes":{"type":"integer","minimum":1,"maximum":5368709120,"description":"Per-file size cap in bytes (default 100 MiB, never above 5 GiB, DOC-16)."},"camera":{"type":"boolean","description":"Offer camera capture for images/PDF (HYP-02)."}},"additionalProperties":false,"description":"File rules of a `file` item (INT-F06). Omitted fields fall back to `flowFileRulesDefaults`."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":20000,"description":"`text`: maximum length in characters (default 2000)."},"min":{"type":"number","nullable":true,"description":"`number`: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"`number`: inclusive maximum."},"decimals":{"type":"integer","nullable":true,"minimum":0,"maximum":6,"description":"`number`: allowed decimals."},"unit":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"`number`: unit label (for example \"years\")."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false,"description":"Choice option of a `choice` item."},"maxItems":50,"description":"`choice`: the options."},"multiple":{"type":"boolean","description":"`choice`: allow more than one option."}},"additionalProperties":false,"description":"Answer rules of a `text`, `number`, `date` or `choice` item (INT-F05). Omitted fields fall back to `flowAnswerRulesDefaults`."},"group":{"type":"object","nullable":true,"properties":{"groupId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Group id within the template (E20 `required: \"group\"`)."},"satisfiedBy":{"type":"string","enum":["any_of"],"description":"Only `any_of` in the MVP: one approved option satisfies the group."},"option":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Option code of this item within the group."}},"required":["groupId","satisfiedBy","option"],"additionalProperties":false,"description":"Group of alternatives (E20 `required: \"group\"`, INT-F06)."},"documentType":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable lower snake case code (never a label)."},"validity":{"type":"object","nullable":true,"properties":{"rule":{"type":"string","enum":["none","max_age","not_expired","covers_years"],"description":"E20 validity rule (HYP-06)."},"months":{"type":"integer","nullable":true,"minimum":0,"maximum":600,"description":"Age or cover window in months."}},"required":["rule","months"],"additionalProperties":false,"description":"E20 validity rule (HYP-06)."},"bsnSensitive":{"type":"boolean"},"idPhotoMustStayVisible":{"type":"boolean"}},"required":["id","flowId","sectionId","position","type","title","instructions","status","revision","required","allowNotApplicable","assignees","visibility","review","dueDate","overdue","skippedAt","lastSubmissionKind","submission","fileRules","answerRules","group","documentType","validity","bsnSensitive","idPhotoMustStayVisible"],"description":"Item view computed from firm-written and guest-owned rows (INT-F07a)."},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"templateId":{"type":"string","nullable":true,"maxLength":100},"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipient":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"email":{"type":"string","maxLength":320,"format":"email"}},"required":["name","email"],"description":"The one person a request is addressed to (client data)."},"portalUrl":{"type":"string","nullable":true,"description":"Always null on the real stack: the link token is only ever in the request e-mail."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group bound to the party; null until the firm binds it."}},"required":["slot","label","groupId"],"additionalProperties":false,"description":"Room-bound party of a request (WF01): applicant slot, display label, room group."},"description":"Named room parties of this request (WF01); empty on legacy rows without a scope."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): bound parties share drafts. False keeps slot-private answers."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance. Null on legacy rows without a period."},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."},"targetFolderId":{"type":"string","nullable":true,"format":"uuid","description":"Room-index folder the approved files go into; null = root."},"targetFolderTitle":{"type":"string","nullable":true},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"overdue":{"type":"boolean"},"authStrength":{"type":"string","nullable":true,"enum":["single","mfa",null],"description":"Strength of the client session that submitted the item (ADR-0013 D1 condition 1)."},"bsnAutoMask":{"type":"boolean","description":"The worker burns every BSN out of a delivered file before approval (ADR-0053)."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number","targetFolderId","targetFolderTitle","submittedAt","overdue","authStrength"],"description":"Request item as the firm sees it."}},"createdAt":{"type":"string","format":"date-time"},"sentAt":{"type":"string","nullable":true,"format":"date-time"},"openedAt":{"type":"string","nullable":true,"format":"date-time"},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"reminders":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"description":"Reminders sent so far (automatic and manual)."},"lastAt":{"type":"string","nullable":true,"format":"date-time"},"nextAt":{"type":"string","nullable":true,"format":"date-time","description":"Next automatic reminder; null when none is due."},"paused":{"type":"boolean"}},"required":["count","lastAt","nextAt","paused"],"description":"Reminder state (ADR-0053)."}},"required":["id","roomId","templateId","title","message","status","dueDate","recipient","portalUrl","parties","joint","periodContext","expiresAt","coverInstructions","displayStatus","progress","sections","items","createdAt","sentAt","openedAt","submittedAt","completedAt","updatedAt"],"description":"Document request (request-flow profile, firm view)."}]}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"ACTOR_NOT_ALLOWED: no manage on the item or not a professional action.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"NOT_FOUND: the item is invisible to the caller.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"FLOW_NOT_ACTIVE, REVISION_CONFLICT or ITEM_STATE_CONFLICT (INT-F14).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"422":{"description":"REASON_CODE_INVALID, REASON_NOTE_REQUIRED or DOCUMENT_DATE_REQUIRED (INT-F16).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/review-items":{"get":{"operationId":"listReviewItems","summary":"Cross-room review queue","description":"Submitted and in-review items across all rooms where the caller holds manage on the item node (INT-F15, S-FIRM-10). Filters: room, request, assignee slot, status, due window and open question; keyset paginated (1,000 items in 50-row pages). Requires flow_item.review; a guest gets 404 on every review endpoint. Navigation read: no audit event.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"roomId","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"flowId","in":"query"},{"schema":{"type":"string","pattern":"^(client|all_recipients|organisation|applicant_[1-9][0-9]?)$","description":"Assignee slot: client, all_recipients, organisation or applicant_<n>."},"required":false,"description":"Assignee slot: client, all_recipients, organisation or applicant_<n>.","name":"assigneeSlot","in":"query"},{"schema":{"type":"string","enum":["to_do","submitted","in_review","approved","rejected","not_applicable","cancelled"],"description":"Item status (INT-F14)."},"required":false,"description":"Item status (INT-F14).","name":"status","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"dueBefore","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"dueAfter","in":"query"},{"schema":{"type":"boolean"},"required":false,"name":"hasOpenQuestion","in":"query"},{"schema":{"type":"string","maxLength":200,"description":"Keyset cursor (INT-F15: 1,000 rows in 50-row pages)."},"required":false,"description":"Keyset cursor (INT-F15: 1,000 rows in 50-row pages).","name":"cursor","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Review queue page.","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"flowId":{"type":"string","format":"uuid"},"itemId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"roomName":{"type":"string"},"flowTitle":{"type":"string"},"itemTitle":{"type":"string"},"assigneeSlot":{"type":"string","pattern":"^(client|all_recipients|organisation|applicant_[1-9][0-9]?)$","description":"Assignee slot: client, all_recipients, organisation or applicant_<n>."},"submittedAt":{"type":"string","format":"date-time"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","in_review","approved","rejected","not_applicable","cancelled"],"description":"Item status (INT-F14)."},"scanState":{"type":"string","enum":["scanning","available","rejected","failed","none"]},"hasOpenQuestion":{"type":"boolean"}},"required":["flowId","itemId","roomId","roomName","flowTitle","itemTitle","assigneeSlot","submittedAt","dueDate","status","scanState","hasOpenQuestion"],"description":"One row of the cross-room review queue (INT-F15)."}},"nextCursor":{"type":"string","nullable":true,"description":"Cursor for the next page, or null at the end."}},"required":["items","nextCursor"],"description":"Cross-room review queue page (INT-F15)."}}}},"400":{"description":"Invalid filter.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: no review permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/flows/{flowId}/items/{itemId}/history":{"get":{"operationId":"getFlowItemHistory","summary":"Review history of one item","description":"Who decided, when, and why for one flow item (INT-F16). Reason codes and note ids only, never note text (ADR-0006 D3.3). Requires flow_item.review on the item node; a guest gets 404. Navigation read: no audit event.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"}],"responses":{"200":{"description":"Item review history, oldest first.","content":{"application/json":{"schema":{"type":"object","properties":{"flowId":{"type":"string","format":"uuid"},"itemId":{"type":"string","format":"uuid"},"entries":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","enum":["review_started","approved","rejected","rerequested","waived"]},"occurredAt":{"type":"string","format":"date-time"},"actorPrincipalId":{"type":"string","nullable":true,"format":"uuid","description":"Reviewer principal; null when unattributed."},"reasonCode":{"type":"string","nullable":true,"maxLength":64,"description":"Uppercase reason code; null when none."},"noteId":{"type":"string","nullable":true,"format":"uuid","description":"Note id when a note was recorded; never the note text."},"submissionId":{"type":"string","nullable":true,"format":"uuid","description":"Submission this entry belongs to; null when unknown."}},"required":["action","occurredAt","actorPrincipalId","reasonCode","noteId","submissionId"],"description":"One review-history entry of a flow item (INT-F16, ADR-0006 D3.3)."},"description":"Oldest first."}},"required":["flowId","itemId","entries"],"description":"Review history of one flow item (INT-F16)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: no review permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, flow or item (PERM-02 hides existence).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/permissions/groups":{"get":{"operationId":"listRoomGroups","summary":"List the groups of a room","description":"Groups with their kind, settings and expiry (ADR-0005 §4, PERM-01/PERM-12). Requires `permission.read` (`manage` on the room root, or `compliance`); guests never see other groups or their members. 404 hides existence (including cross-tenant, PERM-02).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"Groups of the room.","content":{"application/json":{"schema":{"type":"object","properties":{"groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Group id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"roomId":{"type":"string","format":"uuid","description":"Owning room."},"name":{"type":"string","nullable":true,"description":"Group name (firm-visible, scrubbed at tenant termination)."},"kind":{"type":"string","enum":["internal","client","counterparty","expert","custom_external"],"description":"Group kind (ADR-0005 §4). Everything except `internal` is an external group."},"department":{"type":"object","nullable":true,"properties":{"departmentId":{"type":"string","minLength":1,"maxLength":100,"description":"Stable department id within the tenant (opaque; e.g. \"ams-corporate\")."},"office":{"type":"string","nullable":true,"minLength":1,"maxLength":200,"description":"Human-readable office label, or null when the department spans offices."},"team":{"type":"string","nullable":true,"minLength":1,"maxLength":200,"description":"Human-readable team label, or null when the department has no sub-team."}},"required":["departmentId"],"additionalProperties":false,"description":"Office/team profile of the group (ORG-11, T-261005-f081). Absent or null means unassigned; firm metadata like the group name, always read through the tenant-scoped group routes."},"settings":{"type":"object","properties":{"watermark":{"type":"boolean","description":"Draw the personal watermark on viewer pages (on by default for external groups)."},"downloadAsWatermarkedPdf":{"type":"boolean","description":"PDF only: members see and download only the watermarked PDF rendition, never the source file (no original download, ZIP of originals, file share, spreadsheet cell grid, or source name, type, size or fingerprint in the API)."},"seeGroupMembers":{"type":"boolean","description":"Members may see the other members of their own group; guests never see other groups."},"viewerProtection":{"type":"string","enum":["inherit","off","standard","strict"],"description":"Screenshot protection level of the group (ADR-0066). Absent = `inherit`."}},"required":["watermark","downloadAsWatermarkedPdf","seeGroupMembers"],"additionalProperties":false,"description":"Group settings (PERM-12, ADR-0005 §4)."},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Access end date for the whole group, or null (PERM-09)."},"memberCount":{"type":"integer","minimum":0,"description":"Number of members."},"medicalAccess":{"type":"boolean","description":"The group may reach the special-category zones of the room (ADR-0056). Absent means false."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."}},"required":["id","tenantId","roomId","name","kind","settings","expiresAt","memberCount","createdAt"],"description":"A group of one room (ADR-0005 §4)."},"description":"Groups of the room, internal first."}},"required":["groups"],"description":"List room groups response."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"post":{"operationId":"createRoomGroup","summary":"Create a group in a room","description":"Creates a group of the given kind (ADR-0005 §4, PERM-01). Requires `manage` on the room root (`permission.update`); settings default per kind (external groups watermark by default, PERM-12). Writes group.created.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200,"description":"Group name."},"kind":{"type":"string","enum":["internal","client","counterparty","expert","custom_external"],"description":"Group kind (ADR-0005 §4). Everything except `internal` is an external group."},"department":{"type":"object","properties":{"departmentId":{"type":"string","minLength":1,"maxLength":100,"description":"Stable department id within the tenant (opaque; e.g. \"ams-corporate\")."},"office":{"type":"string","nullable":true,"minLength":1,"maxLength":200,"description":"Human-readable office label, or null when the department spans offices."},"team":{"type":"string","nullable":true,"minLength":1,"maxLength":200,"description":"Human-readable team label, or null when the department has no sub-team."}},"required":["departmentId"],"additionalProperties":false,"description":"Office/team profile to attach at creation (ORG-11); omit for unassigned."},"settings":{"type":"object","properties":{"watermark":{"type":"boolean","description":"Draw the personal watermark on viewer pages (on by default for external groups)."},"downloadAsWatermarkedPdf":{"type":"boolean","description":"PDF only: members see and download only the watermarked PDF rendition, never the source file (no original download, ZIP of originals, file share, spreadsheet cell grid, or source name, type, size or fingerprint in the API)."},"seeGroupMembers":{"type":"boolean","description":"Members may see the other members of their own group; guests never see other groups."},"viewerProtection":{"type":"string","enum":["inherit","off","standard","strict"],"description":"Screenshot protection level of the group (ADR-0066). Absent = `inherit`."}},"additionalProperties":false,"description":"Defaults per kind when omitted (external groups watermark by default)."},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Access end date for the group (PERM-09)."}},"required":["name","kind"],"additionalProperties":false,"description":"Create a room group."}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Group id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"roomId":{"type":"string","format":"uuid","description":"Owning room."},"name":{"type":"string","nullable":true,"description":"Group name (firm-visible, scrubbed at tenant termination)."},"kind":{"type":"string","enum":["internal","client","counterparty","expert","custom_external"],"description":"Group kind (ADR-0005 §4). Everything except `internal` is an external group."},"department":{"type":"object","nullable":true,"properties":{"departmentId":{"type":"string","minLength":1,"maxLength":100,"description":"Stable department id within the tenant (opaque; e.g. \"ams-corporate\")."},"office":{"type":"string","nullable":true,"minLength":1,"maxLength":200,"description":"Human-readable office label, or null when the department spans offices."},"team":{"type":"string","nullable":true,"minLength":1,"maxLength":200,"description":"Human-readable team label, or null when the department has no sub-team."}},"required":["departmentId"],"additionalProperties":false,"description":"Office/team profile of the group (ORG-11, T-261005-f081). Absent or null means unassigned; firm metadata like the group name, always read through the tenant-scoped group routes."},"settings":{"type":"object","properties":{"watermark":{"type":"boolean","description":"Draw the personal watermark on viewer pages (on by default for external groups)."},"downloadAsWatermarkedPdf":{"type":"boolean","description":"PDF only: members see and download only the watermarked PDF rendition, never the source file (no original download, ZIP of originals, file share, spreadsheet cell grid, or source name, type, size or fingerprint in the API)."},"seeGroupMembers":{"type":"boolean","description":"Members may see the other members of their own group; guests never see other groups."},"viewerProtection":{"type":"string","enum":["inherit","off","standard","strict"],"description":"Screenshot protection level of the group (ADR-0066). Absent = `inherit`."}},"required":["watermark","downloadAsWatermarkedPdf","seeGroupMembers"],"additionalProperties":false,"description":"Group settings (PERM-12, ADR-0005 §4)."},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Access end date for the whole group, or null (PERM-09)."},"memberCount":{"type":"integer","minimum":0,"description":"Number of members."},"medicalAccess":{"type":"boolean","description":"The group may reach the special-category zones of the room (ADR-0056). Absent means false."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."}},"required":["id","tenantId","roomId","name","kind","settings","expiresAt","memberCount","createdAt"],"description":"A group of one room (ADR-0005 §4)."}}}},"400":{"description":"Invalid group.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `manage` on the room root, or delegation limit).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/permissions/groups/{groupId}":{"patch":{"operationId":"updateRoomGroup","summary":"Update a group name, settings or expiry","description":"Changes the group settings (PERM-12) and/or its access end date (PERM-09, ADR-0005 §4). Requires `manage` on the room root (`permission.update`). Changing a kind is not part of this contract. Writes audit events for the changed fields, IDs only.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Group id."},"required":true,"description":"Group id.","name":"groupId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"department":{"type":"object","nullable":true,"properties":{"departmentId":{"type":"string","minLength":1,"maxLength":100,"description":"Stable department id within the tenant (opaque; e.g. \"ams-corporate\")."},"office":{"type":"string","nullable":true,"minLength":1,"maxLength":200,"description":"Human-readable office label, or null when the department spans offices."},"team":{"type":"string","nullable":true,"minLength":1,"maxLength":200,"description":"Human-readable team label, or null when the department has no sub-team."}},"required":["departmentId"],"additionalProperties":false,"description":"Replace the office/team profile, or null to clear it; omit to keep it (ORG-11)."},"settings":{"type":"object","properties":{"watermark":{"type":"boolean","description":"Draw the personal watermark on viewer pages (on by default for external groups)."},"downloadAsWatermarkedPdf":{"type":"boolean","description":"PDF only: members see and download only the watermarked PDF rendition, never the source file (no original download, ZIP of originals, file share, spreadsheet cell grid, or source name, type, size or fingerprint in the API)."},"seeGroupMembers":{"type":"boolean","description":"Members may see the other members of their own group; guests never see other groups."},"viewerProtection":{"type":"string","enum":["inherit","off","standard","strict"],"description":"Screenshot protection level of the group (ADR-0066). Absent = `inherit`."}},"additionalProperties":false},"expiresAt":{"type":"string","nullable":true,"format":"date-time"}},"additionalProperties":false,"description":"Update a group name, its department profile, its settings or its expiry; an empty body changes nothing."}}}},"responses":{"200":{"description":"Updated.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Group id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"roomId":{"type":"string","format":"uuid","description":"Owning room."},"name":{"type":"string","nullable":true,"description":"Group name (firm-visible, scrubbed at tenant termination)."},"kind":{"type":"string","enum":["internal","client","counterparty","expert","custom_external"],"description":"Group kind (ADR-0005 §4). Everything except `internal` is an external group."},"department":{"type":"object","nullable":true,"properties":{"departmentId":{"type":"string","minLength":1,"maxLength":100,"description":"Stable department id within the tenant (opaque; e.g. \"ams-corporate\")."},"office":{"type":"string","nullable":true,"minLength":1,"maxLength":200,"description":"Human-readable office label, or null when the department spans offices."},"team":{"type":"string","nullable":true,"minLength":1,"maxLength":200,"description":"Human-readable team label, or null when the department has no sub-team."}},"required":["departmentId"],"additionalProperties":false,"description":"Office/team profile of the group (ORG-11, T-261005-f081). Absent or null means unassigned; firm metadata like the group name, always read through the tenant-scoped group routes."},"settings":{"type":"object","properties":{"watermark":{"type":"boolean","description":"Draw the personal watermark on viewer pages (on by default for external groups)."},"downloadAsWatermarkedPdf":{"type":"boolean","description":"PDF only: members see and download only the watermarked PDF rendition, never the source file (no original download, ZIP of originals, file share, spreadsheet cell grid, or source name, type, size or fingerprint in the API)."},"seeGroupMembers":{"type":"boolean","description":"Members may see the other members of their own group; guests never see other groups."},"viewerProtection":{"type":"string","enum":["inherit","off","standard","strict"],"description":"Screenshot protection level of the group (ADR-0066). Absent = `inherit`."}},"required":["watermark","downloadAsWatermarkedPdf","seeGroupMembers"],"additionalProperties":false,"description":"Group settings (PERM-12, ADR-0005 §4)."},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Access end date for the whole group, or null (PERM-09)."},"memberCount":{"type":"integer","minimum":0,"description":"Number of members."},"medicalAccess":{"type":"boolean","description":"The group may reach the special-category zones of the room (ADR-0056). Absent means false."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."}},"required":["id","tenantId","roomId","name","kind","settings","expiresAt","memberCount","createdAt"],"description":"A group of one room (ADR-0005 §4)."}}}},"400":{"description":"Invalid update.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `manage` on the room root).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"LAST_MANAGER: the room would be left without an active internal member holding `manage` on the room root (ADR-0005 §3).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/permissions/groups/{groupId}/members":{"get":{"operationId":"listGroupMembers","summary":"List the members of a group","description":"Memberships of one group (ADR-0005 §4, PERM-01): principal IDs, kind and expiry. A guest sees only its own group and never other groups. Requires `manage` on the room root; 404 hides existence (including cross-tenant, PERM-02).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Group id."},"required":true,"description":"Group id.","name":"groupId","in":"path"}],"responses":{"200":{"description":"Members of the group.","content":{"application/json":{"schema":{"type":"object","properties":{"members":{"type":"array","items":{"type":"object","properties":{"principalId":{"type":"string","format":"uuid","description":"Member principal (a user or a guest)."},"kind":{"type":"string","enum":["user","guest"],"description":"Membership kind: users in internal groups, guests in external groups (ADR-0005 §4)."},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Access end date for this membership, or null (PERM-09)."},"createdAt":{"type":"string","format":"date-time","description":"When the membership was created."}},"required":["principalId","kind","expiresAt","createdAt"],"description":"One membership of a room group."},"description":"Members of the group, oldest first."}},"required":["members"],"description":"List group members response."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"post":{"operationId":"addGroupMember","summary":"Add a member to a group","description":"Adds a user to an internal group or a guest to an external group (ADR-0005 §4, PERM-01); the kind must match or the request is refused. At most one group per principal per room in the MVP. Requires `manage` on the room root (`room.membership.manage`); an optional end date is PERM-09. Writes `room.membership_added` (ADR-0006 D4, `group_id`).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Group id."},"required":true,"description":"Group id.","name":"groupId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"principalId":{"type":"string","format":"uuid","description":"User or guest to add. At most one group per principal per room in the MVP."},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Access end date for this membership (PERM-09)."}},"required":["principalId"],"additionalProperties":false,"description":"Add a member to a group."}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"type":"object","properties":{"principalId":{"type":"string","format":"uuid","description":"Member principal (a user or a guest)."},"kind":{"type":"string","enum":["user","guest"],"description":"Membership kind: users in internal groups, guests in external groups (ADR-0005 §4)."},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Access end date for this membership, or null (PERM-09)."},"createdAt":{"type":"string","format":"date-time","description":"When the membership was created."}},"required":["principalId","kind","expiresAt","createdAt"],"description":"One membership of a room group."}}}},"400":{"description":"Invalid membership (kind mismatch or duplicate).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `manage` on the room root).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/permissions/groups/{groupId}/members/{principalId}":{"delete":{"operationId":"removeGroupMember","summary":"Remove a member from a group","description":"Removes one membership of a group (ADR-0005 §4, PERM-01). Requires `manage` on the room root. The last room manager cannot be removed (ADR-0005 §3): a removal that would leave the room without an active internal member holding `manage` on the room root is refused with 409 `LAST_MANAGER`, not silently ignored. Writes `room.membership_removed` (ADR-0006 D4, `group_id`).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Group id."},"required":true,"description":"Group id.","name":"groupId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Member principal id."},"required":true,"description":"Member principal id.","name":"principalId","in":"path"}],"responses":{"204":{"description":"Removed."},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `manage` on the room root).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"LAST_MANAGER: the room would be left without an active internal member holding `manage` on the room root (ADR-0005 §3).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/permissions/nodes/{nodeId}":{"get":{"operationId":"getNodePermissions","summary":"Read the access of every group on one node","description":"Per-group explicit assignment and effective level on one node (ADR-0005 §5, PERM-03/PERM-04): the access panel data. Requires `permission.read` (`manage` on the node, or `compliance`). Internal-only nodes report external groups as blocked (`blockedBy: internal`, ADR-0005 §6) and never grant them access. 404 hides existence (including cross-tenant, PERM-02).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Index node id."},"required":true,"description":"Index node id.","name":"nodeId","in":"path"}],"responses":{"200":{"description":"Per-group access on the node.","content":{"application/json":{"schema":{"type":"object","properties":{"nodeId":{"type":"string","format":"uuid","description":"Node the access was read for."},"internalOnly":{"type":"boolean","description":"The node or an ancestor is internal-only (ADR-0005 §6); external groups can never be granted access here."},"groups":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":"string","format":"uuid","description":"Group id."},"groupKind":{"type":"string","enum":["internal","client","counterparty","expert","custom_external"],"description":"Group kind (ADR-0005 §4). Everything except `internal` is an external group."},"assignment":{"type":"object","nullable":true,"properties":{"groupId":{"type":"string","format":"uuid","description":"Group the assignment belongs to."},"nodeId":{"type":"string","format":"uuid","description":"Node the assignment is stored on."},"read":{"type":"string","enum":["none","view","print","download"],"description":"Read axis: none < view < print (watermarked PDF) < download (the original)."},"write":{"type":"string","enum":["none","upload_with_approval","upload","edit","manage"],"description":"Write axis: none < upload_with_approval < upload < edit < manage."},"updatedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the assignment last changed; null for a row that predates change tracking."}},"required":["groupId","nodeId","read","write","updatedAt"],"description":"The explicit assignment on this node, or null when the level is inherited."},"effectiveRead":{"type":"string","enum":["none","view","print","download"],"description":"Read axis: none < view < print (watermarked PDF) < download (the original)."},"effectiveWrite":{"type":"string","enum":["none","upload_with_approval","upload","edit","manage"],"description":"Write axis: none < upload_with_approval < upload < edit < manage."},"pendingGates":{"type":"array","items":{"type":"string","enum":["step_up_required","terms_not_accepted"],"description":"An outstanding session-completion condition: step_up_required (the session must still complete MFA step-up before node.read), terms_not_accepted (the principal must still accept the room terms)."},"description":"Session-completion conditions a member session must still satisfy before the effective level becomes readable (T-261016-43e7, probed against a basic single-strength member session of this group). Empty when a completed session could read now. The levels above keep their group-level meaning; the gates never change them."},"accessible":{"type":"boolean","description":"Whether the level is actually readable now: a granted level with no outstanding gate. False when the level is none or any gate is pending."},"inheritedFromNodeId":{"type":"string","nullable":true,"format":"uuid","description":"The nearest node that gave the effective level; null when the result is none/none."},"blockedBy":{"type":"string","nullable":true,"enum":["internal","external_ceiling","medical",null],"description":"Stop the evaluator applied (ADR-0005 §5/§6; `medical`: a special-category zone without the group flag, ADR-0056), or null."},"cannotSet":{"type":"string","nullable":true,"enum":["internal_node","external_ceiling","delegation_limit","invalid_levels",null],"description":"Why setting a level here would be refused for this group, or null when it may be set."}},"required":["groupId","groupKind","assignment","effectiveRead","effectiveWrite","pendingGates","accessible","inheritedFromNodeId","blockedBy","cannotSet"],"description":"One group and its access on one node."},"description":"Every group of the room, with its explicit and effective access on this node."}},"required":["nodeId","internalOnly","groups"],"description":"Node access response: per-group explicit and effective access (PERM-03)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/permissions/nodes/{nodeId}/groups/{groupId}":{"put":{"operationId":"setNodeAssignment","summary":"Set the explicit assignment of one group on one node","description":"Stores `(group, node) → (read, write)` (ADR-0005 §5, PERM-02/PERM-03). Requires `permission.update` (`manage` on the node) and is refused when it exceeds the manager's own level (`delegation_limit`). ADR-0005 constraints apply: `write ∈ {edit, manage}` needs `read ≥ view`, `manage` needs `read = download` (the request schema enforces this, so an invalid pair is 400), an external group never exceeds `upload` (`external_ceiling`, 403) and never gets access to an internal node (`internal_node`, 403, §6). Access administration is deliberately not mutating (package `@ddr/policy`), so a frozen, closed or archived room does not refuse this call. Answers the resulting group access; writes permission.assigned/permission.changed.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Index node id."},"required":true,"description":"Index node id.","name":"nodeId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Group id."},"required":true,"description":"Group id.","name":"groupId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"read":{"type":"string","enum":["none","view","print","download"],"description":"Read axis: none < view < print (watermarked PDF) < download (the original)."},"write":{"type":"string","enum":["none","upload_with_approval","upload","edit","manage"],"description":"Write axis: none < upload_with_approval < upload < edit < manage."}},"required":["read","write"],"additionalProperties":false,"description":"The two ADR-0005 §5 axes of one assignment, constrained by §5."}}}},"responses":{"200":{"description":"Stored assignment and its effective result.","content":{"application/json":{"schema":{"type":"object","properties":{"groupId":{"type":"string","format":"uuid","description":"Group id."},"groupKind":{"type":"string","enum":["internal","client","counterparty","expert","custom_external"],"description":"Group kind (ADR-0005 §4). Everything except `internal` is an external group."},"assignment":{"type":"object","nullable":true,"properties":{"groupId":{"type":"string","format":"uuid","description":"Group the assignment belongs to."},"nodeId":{"type":"string","format":"uuid","description":"Node the assignment is stored on."},"read":{"type":"string","enum":["none","view","print","download"],"description":"Read axis: none < view < print (watermarked PDF) < download (the original)."},"write":{"type":"string","enum":["none","upload_with_approval","upload","edit","manage"],"description":"Write axis: none < upload_with_approval < upload < edit < manage."},"updatedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the assignment last changed; null for a row that predates change tracking."}},"required":["groupId","nodeId","read","write","updatedAt"],"description":"The explicit assignment on this node, or null when the level is inherited."},"effectiveRead":{"type":"string","enum":["none","view","print","download"],"description":"Read axis: none < view < print (watermarked PDF) < download (the original)."},"effectiveWrite":{"type":"string","enum":["none","upload_with_approval","upload","edit","manage"],"description":"Write axis: none < upload_with_approval < upload < edit < manage."},"pendingGates":{"type":"array","items":{"type":"string","enum":["step_up_required","terms_not_accepted"],"description":"An outstanding session-completion condition: step_up_required (the session must still complete MFA step-up before node.read), terms_not_accepted (the principal must still accept the room terms)."},"description":"Session-completion conditions a member session must still satisfy before the effective level becomes readable (T-261016-43e7, probed against a basic single-strength member session of this group). Empty when a completed session could read now. The levels above keep their group-level meaning; the gates never change them."},"accessible":{"type":"boolean","description":"Whether the level is actually readable now: a granted level with no outstanding gate. False when the level is none or any gate is pending."},"inheritedFromNodeId":{"type":"string","nullable":true,"format":"uuid","description":"The nearest node that gave the effective level; null when the result is none/none."},"blockedBy":{"type":"string","nullable":true,"enum":["internal","external_ceiling","medical",null],"description":"Stop the evaluator applied (ADR-0005 §5/§6; `medical`: a special-category zone without the group flag, ADR-0056), or null."},"cannotSet":{"type":"string","nullable":true,"enum":["internal_node","external_ceiling","delegation_limit","invalid_levels",null],"description":"Why setting a level here would be refused for this group, or null when it may be set."}},"required":["groupId","groupKind","assignment","effectiveRead","effectiveWrite","pendingGates","accessible","inheritedFromNodeId","blockedBy","cannotSet"],"description":"One group and its access on one node."}}}},"400":{"description":"Invalid level pair (ADR-0005 §5 constraints).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `manage`, `external_ceiling`, `internal_node` or `delegation_limit`).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"LAST_MANAGER: the room would be left without an active internal member holding `manage` on the room root (ADR-0005 §3).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"delete":{"operationId":"clearNodeAssignment","summary":"Reset one group on one node to inherited","description":"Removes the explicit assignment, so the group inherits from its nearest ancestor again (ADR-0005 §5, PERM-UX05 \"Reset to inherited\"). Requires `permission.update`. Access administration is never blocked by read-only room states (ADR-0005 §8). Writes permission.removed.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Index node id."},"required":true,"description":"Index node id.","name":"nodeId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Group id."},"required":true,"description":"Group id.","name":"groupId","in":"path"}],"responses":{"204":{"description":"Reset to inherited."},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `manage` on the node).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"LAST_MANAGER: the room would be left without an active internal member holding `manage` on the room root (ADR-0005 §3).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/permissions/effective":{"get":{"operationId":"getEffectivePermissions","summary":"Effective access of one principal on one node","description":"Result of ADR-0005 §5/§8 `explain()` for a principal and a node: levels per axis, sources (assignment or the compliance role) and the stops applied (internal, external ceiling). Requires `permission.read` (`manage` on the room root, or `compliance`). Only IDs, never names. 404 hides existence (including cross-tenant, PERM-02). Serves the access panel and compliance review under `permission.read`; it is not the authorization for the \"View as\" preview (T-260914-105d), which requires `manage` on the room root and its own `permission.preview` action.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Principal to evaluate (user or guest of the room)."},"required":true,"description":"Principal to evaluate (user or guest of the room).","name":"principalId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Node to evaluate."},"required":true,"description":"Node to evaluate.","name":"nodeId","in":"query"}],"responses":{"200":{"description":"Effective access.","content":{"application/json":{"schema":{"type":"object","properties":{"principalId":{"type":"string","format":"uuid","description":"Evaluated principal."},"nodeId":{"type":"string","format":"uuid","description":"Evaluated node."},"read":{"type":"string","enum":["none","view","print","download"],"description":"Read axis: none < view < print (watermarked PDF) < download (the original)."},"write":{"type":"string","enum":["none","upload_with_approval","upload","edit","manage"],"description":"Write axis: none < upload_with_approval < upload < edit < manage."},"pendingGates":{"type":"array","items":{"type":"string","enum":["step_up_required","terms_not_accepted"],"description":"An outstanding session-completion condition: step_up_required (the session must still complete MFA step-up before node.read), terms_not_accepted (the principal must still accept the room terms)."},"description":"Session-completion conditions still outstanding for the evaluated session (T-261016-43e7): step_up_required when the session has not completed MFA step-up for node.read, terms_not_accepted while the principal has not accepted the room terms. The levels above keep their group-level explain() meaning; the gates never change them."},"accessible":{"type":"boolean","description":"Whether the subject could actually read now: a granted level with no outstanding gate. False when the level is none or any gate is pending."},"internal":{"type":"boolean","description":"The node or an ancestor is internal-only (ADR-0005 §6)."},"sources":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["assignment"]},"groupId":{"type":"string","format":"uuid"},"nodeId":{"type":"string","nullable":true,"format":"uuid","description":"Node the level came from; null when no assignment applied."},"read":{"type":"string","enum":["none","view","print","download"],"description":"Read axis: none < view < print (watermarked PDF) < download (the original)."},"write":{"type":"string","enum":["none","upload_with_approval","upload","edit","manage"],"description":"Write axis: none < upload_with_approval < upload < edit < manage."}},"required":["kind","groupId","nodeId","read","write"]},{"type":"object","properties":{"kind":{"type":"string","enum":["role"]},"role":{"type":"string","enum":["compliance"]},"read":{"type":"string","enum":["none","view","print","download"],"description":"Read axis: none < view < print (watermarked PDF) < download (the original)."}},"required":["kind","role","read"]}],"description":"Why the effective level was granted (ADR-0005 §8)."}},"stops":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":"string","format":"uuid"},"stop":{"type":"string","enum":["internal","external_ceiling","medical"]}},"required":["groupId","stop"],"description":"A stop the evaluator applied to one group (ADR-0005 §5/§6)."}}},"required":["principalId","nodeId","read","write","pendingGates","accessible","internal","sources","stops"],"description":"Result of `explain()` for one principal on one node (ADR-0005 §8)."}}}},"400":{"description":"Invalid query.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, foreign principal or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/nodes/{nodeId}/internal":{"put":{"operationId":"setNodeInternal","summary":"Mark or clear an internal counsel area","description":"Sets or clears the internal mark of a node (ADR-0005 §6, PERM-05; ADR-0044). The room root cannot be marked (400). Marking needs `node.internal.mark` (`manage`, users only); clearing needs `node.internal.clear` and step-up authentication. Both are mutating, so a frozen, closed or archived room answers 409 READ_ONLY. Internal is sticky: a move never discloses, and when a node becomes internal its external assignments are removed in the same transaction (audited). External groups can never be granted access to an internal node. Answers the materialised state.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Index node id."},"required":true,"description":"Index node id.","name":"nodeId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"internal":{"type":"boolean","description":"true marks the node internal (`node.internal.mark`); false clears it (`node.internal.clear`, step-up, audited)."}},"required":["internal"],"additionalProperties":false,"description":"Mark or clear an internal counsel area (ADR-0005 §6)."}}}},"responses":{"200":{"description":"Internal state after the change.","content":{"application/json":{"schema":{"type":"object","properties":{"nodeId":{"type":"string","format":"uuid","description":"Node the internal state belongs to."},"internalMarked":{"type":"boolean","description":"The internal mark is set on this node itself (ADR-0005 §6)."},"internalOnly":{"type":"boolean","description":"The node or an ancestor is internal-only (materialised `internal_only`)."},"updatedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the mark last changed; null when never set."}},"required":["nodeId","internalMarked","internalOnly","updatedAt"],"description":"Internal counsel marking of one node (PERM-05)."}}}},"400":{"description":"Invalid body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out or step-up required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `manage` on the node, or a guest).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Room is not active (read-only states).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/procedures":{"post":{"operationId":"createProcedure","summary":"Create a procedure in a litigation room","description":"Creates a procedure (PROC-01) in a room that must be of type litigation (422 ROOM_TYPE_NOT_LITIGATION). continuesFromProcedureId needs procedure.read on the linked procedure room (404 PROCEDURE_NOT_FOUND). Requires procedure.manage. Writes procedure.created.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":300},"court":{"type":"string","minLength":1,"maxLength":200},"instance":{"type":"string","enum":["first_instance","appeal"],"description":"Instance of the procedure: first instance (rechtbank) or appeal (gerechtshof)."},"caseType":{"type":"string","enum":["summons","application"],"description":"Case type: summons (dagvaarding, incl. kort geding) or application (verzoekschrift)."},"caseNumber":{"type":"string","minLength":1,"maxLength":100,"description":"Zaaknummer / rolnummer, often not yet known."},"continuesFromProcedureId":{"type":"string","format":"uuid","description":"Appeal link; needs procedure.read on the linked procedure's room (404 otherwise)."}},"required":["title","court","instance","caseType"],"additionalProperties":false,"description":"Create a procedure in a litigation room (422 ROOM_TYPE_NOT_LITIGATION otherwise)."}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Procedure id."},"roomId":{"type":"string","format":"uuid","description":"Litigation room the procedure belongs to."},"title":{"type":"string","minLength":1,"maxLength":300,"description":"Case title, e.g. \"Jansen / Pietersen\" (client data)."},"court":{"type":"string","minLength":1,"maxLength":200,"description":"Court name (free text in the MVP)."},"instance":{"type":"string","enum":["first_instance","appeal"],"description":"Instance of the procedure: first instance (rechtbank) or appeal (gerechtshof)."},"caseType":{"type":"string","enum":["summons","application"],"description":"Case type: summons (dagvaarding, incl. kort geding) or application (verzoekschrift)."},"caseNumber":{"type":"string","nullable":true,"maxLength":100,"description":"Zaaknummer / rolnummer; often unknown before filing."},"continuesFromProcedureId":{"type":"string","nullable":true,"format":"uuid","description":"First-instance procedure this appeal continues; title is shown only with current access."},"status":{"type":"string","enum":["active","closed"],"description":"Procedure status; closed is read-only."},"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp (UTC, ISO-8601)."},"closedAt":{"type":"string","nullable":true,"format":"date-time","description":"Close timestamp, or null while active."}},"required":["id","roomId","title","court","instance","caseType","caseNumber","continuesFromProcedureId","status","revision","createdAt","closedAt"],"description":"One procedure of a litigation room."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no procedure.manage).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, or no access (including cross-tenant). PROCEDURE_NOT_FOUND: the linked procedure does not exist, is in another tenant or is not readable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"422":{"description":"ROOM_TYPE_NOT_LITIGATION.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"get":{"operationId":"listProcedures","summary":"List the procedures of a litigation room","description":"Procedures the caller may see in one room (procedure.read). A linked appeal procedure title is shown only with current access (spec §7). Navigation read: no audit event.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"Procedures of the room.","content":{"application/json":{"schema":{"type":"object","properties":{"procedures":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Procedure id."},"roomId":{"type":"string","format":"uuid","description":"Litigation room the procedure belongs to."},"title":{"type":"string","minLength":1,"maxLength":300,"description":"Case title, e.g. \"Jansen / Pietersen\" (client data)."},"court":{"type":"string","minLength":1,"maxLength":200,"description":"Court name (free text in the MVP)."},"instance":{"type":"string","enum":["first_instance","appeal"],"description":"Instance of the procedure: first instance (rechtbank) or appeal (gerechtshof)."},"caseType":{"type":"string","enum":["summons","application"],"description":"Case type: summons (dagvaarding, incl. kort geding) or application (verzoekschrift)."},"caseNumber":{"type":"string","nullable":true,"maxLength":100,"description":"Zaaknummer / rolnummer; often unknown before filing."},"continuesFromProcedureId":{"type":"string","nullable":true,"format":"uuid","description":"First-instance procedure this appeal continues; title is shown only with current access."},"status":{"type":"string","enum":["active","closed"],"description":"Procedure status; closed is read-only."},"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp (UTC, ISO-8601)."},"closedAt":{"type":"string","nullable":true,"format":"date-time","description":"Close timestamp, or null while active."}},"required":["id","roomId","title","court","instance","caseType","caseNumber","continuesFromProcedureId","status","revision","createdAt","closedAt"],"description":"One procedure of a litigation room."},"description":"Procedures of the room, newest first."}},"required":["procedures"],"description":"Procedures of one litigation room."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, or no access (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/procedures/{procedureId}":{"get":{"operationId":"getProcedure","summary":"Read a procedure with parties and procedural documents","description":"Procedure detail (parties and procedural documents) behind procedure.read; the linked procedure title is included only with current access (spec §7). Exhibit rows inside are redacted per caller (spec §7). Navigation read: no audit event.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Procedure id."},"required":true,"description":"Procedure id.","name":"procedureId","in":"path"}],"responses":{"200":{"description":"Procedure detail.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Procedure id."},"roomId":{"type":"string","format":"uuid","description":"Litigation room the procedure belongs to."},"title":{"type":"string","minLength":1,"maxLength":300,"description":"Case title, e.g. \"Jansen / Pietersen\" (client data)."},"court":{"type":"string","minLength":1,"maxLength":200,"description":"Court name (free text in the MVP)."},"instance":{"type":"string","enum":["first_instance","appeal"],"description":"Instance of the procedure: first instance (rechtbank) or appeal (gerechtshof)."},"caseType":{"type":"string","enum":["summons","application"],"description":"Case type: summons (dagvaarding, incl. kort geding) or application (verzoekschrift)."},"caseNumber":{"type":"string","nullable":true,"maxLength":100,"description":"Zaaknummer / rolnummer; often unknown before filing."},"continuesFromProcedureId":{"type":"string","nullable":true,"format":"uuid","description":"First-instance procedure this appeal continues; title is shown only with current access."},"status":{"type":"string","enum":["active","closed"],"description":"Procedure status; closed is read-only."},"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp (UTC, ISO-8601)."},"closedAt":{"type":"string","nullable":true,"format":"date-time","description":"Close timestamp, or null while active."},"parties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Party id of a procedure."},"procedureId":{"type":"string","format":"uuid","description":"Procedure id."},"role":{"type":"string","enum":["claimant","defendant","applicant","respondent","interested_party","appellant","respondent_on_appeal","intervener","joined_party"],"description":"Role of a party in the procedure."},"displayName":{"type":"string","minLength":1,"maxLength":200,"description":"Full party name as used in the index header (client data)."},"shortName":{"type":"string","minLength":1,"maxLength":40,"description":"Sanitised short name (unique per procedure, case-insensitive)."},"representedByFirm":{"type":"boolean","description":"Default filter in the UI; bundles for other parties are allowed."},"numberingOffset":{"type":"integer","minimum":0,"description":"Appeal continue-numbering offset (0 = start at 1)."},"sortOrder":{"type":"integer","description":"Display order among the procedure parties."},"createdAt":{"type":"string","format":"date-time"}},"required":["id","procedureId","role","displayName","shortName","representedByFirm","numberingOffset","sortOrder","createdAt"],"description":"One party in a procedure."}},"proceduralDocuments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Procedural document id (processtuk)."},"procedureId":{"type":"string","format":"uuid","description":"Procedure id."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"kind":{"type":"string","enum":["summons","statement_of_defence","reply","rejoinder","counterclaim_reply","deed_of_production","deed_of_response","deed_other","hearing_documents","interlocutory_motion","application","statement_of_response","statement_of_appeal","statement_of_response_on_appeal","other"],"description":"Kind of procedural document (processtuk)."},"title":{"type":"string","nullable":true,"maxLength":300,"description":"Custom label; defaults to the NL label of `kind`."},"sequence":{"type":"integer","minimum":0,"description":"Order within the procedure (submitted before drafts)."},"status":{"type":"string","enum":["draft","submitted"],"description":"Procedural document status: only drafts can be reordered or edited."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Optional link to the processtuk in the room index; null after a hard delete of the source and omitted entirely when the caller cannot view it (spec §7)."},"filedOn":{"type":"string","nullable":true,"format":"date","description":"Date the user entered when marking as submitted."},"submittedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","procedureId","partyId","kind","title","sequence","status","filedOn","submittedAt"],"description":"One procedural document (processtuk)."}}},"required":["id","roomId","title","court","instance","caseType","caseNumber","continuesFromProcedureId","status","revision","createdAt","closedAt","parties","proceduralDocuments"],"description":"One procedure with its parties and procedural documents."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or procedure, or no access (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"patch":{"operationId":"updateProcedure","summary":"Patch a procedure","description":"Edits title, court, case number or the appeal link (procedure.manage, mutating: a closed procedure or non-active room answers 409 READ_ONLY). The same link check as create applies. Writes procedure.updated.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Procedure id."},"required":true,"description":"Procedure id.","name":"procedureId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":300},"court":{"type":"string","minLength":1,"maxLength":200},"caseNumber":{"type":"string","nullable":true,"minLength":1,"maxLength":100},"continuesFromProcedureId":{"type":"string","nullable":true,"format":"uuid","description":"Procedure id."},"expectedRevision":{"type":"integer","minimum":1,"description":"Revision the caller last saw; a mismatch answers 409 REVISION_CONFLICT."}},"additionalProperties":false,"description":"Patch a procedure; the same link check as create applies."}}}},"responses":{"200":{"description":"Updated.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Procedure id."},"roomId":{"type":"string","format":"uuid","description":"Litigation room the procedure belongs to."},"title":{"type":"string","minLength":1,"maxLength":300,"description":"Case title, e.g. \"Jansen / Pietersen\" (client data)."},"court":{"type":"string","minLength":1,"maxLength":200,"description":"Court name (free text in the MVP)."},"instance":{"type":"string","enum":["first_instance","appeal"],"description":"Instance of the procedure: first instance (rechtbank) or appeal (gerechtshof)."},"caseType":{"type":"string","enum":["summons","application"],"description":"Case type: summons (dagvaarding, incl. kort geding) or application (verzoekschrift)."},"caseNumber":{"type":"string","nullable":true,"maxLength":100,"description":"Zaaknummer / rolnummer; often unknown before filing."},"continuesFromProcedureId":{"type":"string","nullable":true,"format":"uuid","description":"First-instance procedure this appeal continues; title is shown only with current access."},"status":{"type":"string","enum":["active","closed"],"description":"Procedure status; closed is read-only."},"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp (UTC, ISO-8601)."},"closedAt":{"type":"string","nullable":true,"format":"date-time","description":"Close timestamp, or null while active."}},"required":["id","roomId","title","court","instance","caseType","caseNumber","continuesFromProcedureId","status","revision","createdAt","closedAt"],"description":"One procedure of a litigation room."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no procedure.manage).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or procedure, or no access. PROCEDURE_NOT_FOUND: the linked procedure does not exist, is in another tenant or is not readable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"REVISION_CONFLICT or READ_ONLY.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/procedures/{procedureId}/close":{"post":{"operationId":"closeProcedure","summary":"Close a procedure","description":"Marks the procedure closed (read-only afterwards). procedure.manage; 409 FILING_PROMOTION_PENDING while an active filing of the procedure has a pending promotion (spec §4.8). Writes procedure.closed and bumps the revision.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Procedure id."},"required":true,"description":"Procedure id.","name":"procedureId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"expectedRevision":{"type":"integer","minimum":1,"description":"Optional guard; a mismatch answers 409 REVISION_CONFLICT."}},"additionalProperties":false,"description":"Close a procedure (409 FILING_PROMOTION_PENDING while a filing promotion is pending)."}}}},"responses":{"200":{"description":"Closed.","content":{"application/json":{"schema":{"type":"object","properties":{"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."}},"required":["revision"],"description":"The procedure revision after the mutation."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no procedure.manage).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or procedure, or no access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"REVISION_CONFLICT, READ_ONLY or FILING_PROMOTION_PENDING.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/procedures/{procedureId}/parties":{"post":{"operationId":"createProcedureParty","summary":"Add a party to a procedure","description":"Adds a party (role, display name, sanitised short name, appeal numbering). procedure.manage; linkedPartyId needs procedure.read on the linked procedure room (404 PROCEDURE_NOT_FOUND) and must belong to continuesFromProcedureId (422 PARTY_MISMATCH). Writes procedure_party.created.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Procedure id."},"required":true,"description":"Procedure id.","name":"procedureId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","enum":["claimant","defendant","applicant","respondent","interested_party","appellant","respondent_on_appeal","intervener","joined_party"],"description":"Role of a party in the procedure."},"displayName":{"type":"string","minLength":1,"maxLength":200},"shortName":{"type":"string","minLength":1,"maxLength":40},"representedByFirm":{"type":"boolean","description":"Defaults to true for the firm side."},"numbering":{"oneOf":[{"type":"object","properties":{"strategy":{"type":"string","enum":["continue"]},"linkedPartyId":{"type":"string","format":"uuid","description":"Party of the linked first-instance procedure to continue numbering from."}},"required":["strategy","linkedPartyId"],"description":"Continue the linked party numbering; the highest number becomes the offset."},{"type":"object","properties":{"strategy":{"type":"string","enum":["restart"]}},"required":["strategy"],"description":"Restart this party numbering at 1 (offset 0)."}],"description":"Appeal numbering choice; on first-instance procedures the server restarts at 1."},"expectedRevision":{"type":"integer","minimum":1,"description":"Revision the caller last saw; a mismatch answers 409 REVISION_CONFLICT."}},"required":["role","displayName","shortName"],"additionalProperties":false,"description":"Add a party to a procedure (422 PARTY_MISMATCH when the linked party does not match)."}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Party id of a procedure."},"procedureId":{"type":"string","format":"uuid","description":"Procedure id."},"role":{"type":"string","enum":["claimant","defendant","applicant","respondent","interested_party","appellant","respondent_on_appeal","intervener","joined_party"],"description":"Role of a party in the procedure."},"displayName":{"type":"string","minLength":1,"maxLength":200,"description":"Full party name as used in the index header (client data)."},"shortName":{"type":"string","minLength":1,"maxLength":40,"description":"Sanitised short name (unique per procedure, case-insensitive)."},"representedByFirm":{"type":"boolean","description":"Default filter in the UI; bundles for other parties are allowed."},"numberingOffset":{"type":"integer","minimum":0,"description":"Appeal continue-numbering offset (0 = start at 1)."},"sortOrder":{"type":"integer","description":"Display order among the procedure parties."},"createdAt":{"type":"string","format":"date-time"},"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."}},"required":["id","procedureId","role","displayName","shortName","representedByFirm","numberingOffset","sortOrder","createdAt","revision"],"description":"Updated party with the procedure revision after the mutation."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no procedure.manage).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or procedure, or no access. PROCEDURE_NOT_FOUND: the linked party procedure does not exist, is in another tenant or is not readable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"REVISION_CONFLICT, READ_ONLY or SHORT_NAME_NOT_UNIQUE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"422":{"description":"PARTY_MISMATCH, SHORT_NAME_EMPTY or SHORT_NAME_TOO_LONG.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/procedure-parties/{partyId}":{"patch":{"operationId":"updateProcedureParty","summary":"Patch a party","description":"Edits display name, short name or the represented-by-firm flag. procedure.manage; a short-name change is audited by field key only, never the value. Writes procedure_party.updated.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Party id of a procedure."},"required":true,"description":"Party id of a procedure.","name":"partyId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"displayName":{"type":"string","minLength":1,"maxLength":200},"shortName":{"type":"string","minLength":1,"maxLength":40},"representedByFirm":{"type":"boolean"},"expectedRevision":{"type":"integer","minimum":1,"description":"Revision the caller last saw; a mismatch answers 409 REVISION_CONFLICT."}},"additionalProperties":false,"description":"Patch a party (short name changes are audited without the value)."}}}},"responses":{"200":{"description":"Updated.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Party id of a procedure."},"procedureId":{"type":"string","format":"uuid","description":"Procedure id."},"role":{"type":"string","enum":["claimant","defendant","applicant","respondent","interested_party","appellant","respondent_on_appeal","intervener","joined_party"],"description":"Role of a party in the procedure."},"displayName":{"type":"string","minLength":1,"maxLength":200,"description":"Full party name as used in the index header (client data)."},"shortName":{"type":"string","minLength":1,"maxLength":40,"description":"Sanitised short name (unique per procedure, case-insensitive)."},"representedByFirm":{"type":"boolean","description":"Default filter in the UI; bundles for other parties are allowed."},"numberingOffset":{"type":"integer","minimum":0,"description":"Appeal continue-numbering offset (0 = start at 1)."},"sortOrder":{"type":"integer","description":"Display order among the procedure parties."},"createdAt":{"type":"string","format":"date-time"},"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."}},"required":["id","procedureId","role","displayName","shortName","representedByFirm","numberingOffset","sortOrder","createdAt","revision"],"description":"Updated party with the procedure revision after the mutation."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no procedure.manage).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or party, or no access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"REVISION_CONFLICT, READ_ONLY or SHORT_NAME_NOT_UNIQUE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"422":{"description":"SHORT_NAME_EMPTY or SHORT_NAME_TOO_LONG.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"delete":{"operationId":"deleteProcedureParty","summary":"Delete a party","description":"Deletes a party without procedural documents (409 PARTY_NOT_EMPTY otherwise). procedure.manage; Writes procedure_party.deleted and bumps the revision.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Party id of a procedure."},"required":true,"description":"Party id of a procedure.","name":"partyId","in":"path"}],"responses":{"200":{"description":"Deleted; returns the updated revision.","content":{"application/json":{"schema":{"type":"object","properties":{"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."}},"required":["revision"],"description":"The procedure revision after the mutation."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no procedure.manage).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or party, or no access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"REVISION_CONFLICT, READ_ONLY or PARTY_NOT_EMPTY.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/procedures/{procedureId}/exhibit-names/suggest":{"post":{"operationId":"suggestExhibitName","summary":"Suggest a sanitised short name for a party display name","description":"POST (not a query string) so the display name never reaches URLs or access logs. Pure derivation (spec §5.2); the user confirms. procedure.read; no audit event.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Procedure id."},"required":true,"description":"Procedure id.","name":"procedureId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"displayName":{"type":"string","minLength":1,"maxLength":200,"description":"Party display name to derive a short name from; POST so it never reaches access logs."}},"required":["displayName"],"additionalProperties":false,"description":"Request a short-name suggestion for a party display name."}}}},"responses":{"200":{"description":"Suggestion (possibly empty).","content":{"application/json":{"schema":{"type":"object","properties":{"suggestion":{"type":"string","maxLength":40,"description":"Proposed short name after sanitising; empty when nothing survives."},"suggestionValid":{"type":"boolean","description":"False when the proposal is empty or longer than 40 characters."}},"required":["suggestion","suggestionValid"],"description":"Short-name suggestion; the user confirms or types their own."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or procedure, or no access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/procedures/{procedureId}/procedural-documents":{"post":{"operationId":"createProceduralDocument","summary":"Create a procedural document for a party","description":"Creates a draft processtuk (kind, optional title or linked document). exhibit.manage; documentId must be in the same room (404 DOCUMENT_NOT_FOUND). Writes procedural_document.created.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Procedure id."},"required":true,"description":"Procedure id.","name":"procedureId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"kind":{"type":"string","enum":["summons","statement_of_defence","reply","rejoinder","counterclaim_reply","deed_of_production","deed_of_response","deed_other","hearing_documents","interlocutory_motion","application","statement_of_response","statement_of_appeal","statement_of_response_on_appeal","other"],"description":"Kind of procedural document (processtuk)."},"title":{"type":"string","minLength":1,"maxLength":300,"description":"Required for kind `other`."},"documentId":{"type":"string","format":"uuid","description":"Optional processtuk in the same room (404 DOCUMENT_NOT_FOUND otherwise)."},"expectedRevision":{"type":"integer","minimum":1,"description":"Revision the caller last saw; a mismatch answers 409 REVISION_CONFLICT."}},"required":["partyId","kind"],"additionalProperties":false,"description":"Create a procedural document for a party."}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Procedural document id (processtuk)."},"procedureId":{"type":"string","format":"uuid","description":"Procedure id."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"kind":{"type":"string","enum":["summons","statement_of_defence","reply","rejoinder","counterclaim_reply","deed_of_production","deed_of_response","deed_other","hearing_documents","interlocutory_motion","application","statement_of_response","statement_of_appeal","statement_of_response_on_appeal","other"],"description":"Kind of procedural document (processtuk)."},"title":{"type":"string","nullable":true,"maxLength":300,"description":"Custom label; defaults to the NL label of `kind`."},"sequence":{"type":"integer","minimum":0,"description":"Order within the procedure (submitted before drafts)."},"status":{"type":"string","enum":["draft","submitted"],"description":"Procedural document status: only drafts can be reordered or edited."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Optional link to the processtuk in the room index; null after a hard delete of the source and omitted entirely when the caller cannot view it (spec §7)."},"filedOn":{"type":"string","nullable":true,"format":"date","description":"Date the user entered when marking as submitted."},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."}},"required":["id","procedureId","partyId","kind","title","sequence","status","filedOn","submittedAt","revision"],"description":"Updated procedural document with the procedure revision after the mutation."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no exhibit.manage).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, procedure or document, or no access. DOCUMENT_NOT_FOUND: the linked document is in another room or tenant, or not readable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"REVISION_CONFLICT or READ_ONLY.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"422":{"description":"Invalid kind/title combination (kind other requires a title).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/procedural-documents/{proceduralDocumentId}":{"patch":{"operationId":"updateProceduralDocument","summary":"Patch or move a procedural document","description":"Edits title, kind or the linked document, or moves the draft among the party drafts (409 SEQUENCE_NOT_ALLOWED before a submitted document). A sequence move requires expectedRevision and writes procedural_document.moved plus exhibit.renumbered when numbers changed. Writes procedural_document.updated otherwise.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Procedural document id (processtuk)."},"required":true,"description":"Procedural document id (processtuk).","name":"proceduralDocumentId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","nullable":true,"minLength":1,"maxLength":300},"kind":{"type":"string","enum":["summons","statement_of_defence","reply","rejoinder","counterclaim_reply","deed_of_production","deed_of_response","deed_other","hearing_documents","interlocutory_motion","application","statement_of_response","statement_of_appeal","statement_of_response_on_appeal","other"],"description":"Kind of procedural document (processtuk)."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Document id."},"sequence":{"type":"integer","minimum":0,"description":"Move among the draft documents of the party (409 SEQUENCE_NOT_ALLOWED otherwise)."},"expectedRevision":{"type":"integer","minimum":1,"description":"Revision the caller last saw; a mismatch answers 409 REVISION_CONFLICT."}},"additionalProperties":false,"description":"Patch a procedural document; a sequence move requires expectedRevision."}}}},"responses":{"200":{"description":"Updated.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Procedural document id (processtuk)."},"procedureId":{"type":"string","format":"uuid","description":"Procedure id."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"kind":{"type":"string","enum":["summons","statement_of_defence","reply","rejoinder","counterclaim_reply","deed_of_production","deed_of_response","deed_other","hearing_documents","interlocutory_motion","application","statement_of_response","statement_of_appeal","statement_of_response_on_appeal","other"],"description":"Kind of procedural document (processtuk)."},"title":{"type":"string","nullable":true,"maxLength":300,"description":"Custom label; defaults to the NL label of `kind`."},"sequence":{"type":"integer","minimum":0,"description":"Order within the procedure (submitted before drafts)."},"status":{"type":"string","enum":["draft","submitted"],"description":"Procedural document status: only drafts can be reordered or edited."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Optional link to the processtuk in the room index; null after a hard delete of the source and omitted entirely when the caller cannot view it (spec §7)."},"filedOn":{"type":"string","nullable":true,"format":"date","description":"Date the user entered when marking as submitted."},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."}},"required":["id","procedureId","partyId","kind","title","sequence","status","filedOn","submittedAt","revision"],"description":"Updated procedural document with the procedure revision after the mutation."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no exhibit.manage).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or document, or no access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"REVISION_CONFLICT, READ_ONLY or SEQUENCE_NOT_ALLOWED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"delete":{"operationId":"deleteProceduralDocument","summary":"Delete an empty draft procedural document","description":"Draft without exhibits only (409 PROCEDURAL_DOCUMENT_NOT_EMPTY); a submitted one answers 409 PROCEDURAL_DOCUMENT_SUBMITTED. exhibit.manage; writes procedural_document.deleted and bumps the revision.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Procedural document id (processtuk)."},"required":true,"description":"Procedural document id (processtuk).","name":"proceduralDocumentId","in":"path"}],"responses":{"200":{"description":"Deleted; returns the updated revision.","content":{"application/json":{"schema":{"type":"object","properties":{"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."}},"required":["revision"],"description":"The procedure revision after the mutation."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no exhibit.manage).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or document, or no access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"REVISION_CONFLICT, READ_ONLY, PROCEDURAL_DOCUMENT_NOT_EMPTY or PROCEDURAL_DOCUMENT_SUBMITTED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/procedural-documents/{proceduralDocumentId}/submit":{"post":{"operationId":"submitProceduralDocument","summary":"Mark a procedural document as submitted","description":"Freezes the exhibits of the party earliest draft (409 SUBMIT_ORDER_VIOLATION otherwise), snapshots the filing manifest and enqueues the promotion job (spec §4.4, §9.5). The bundle must match the current revision (409 BUNDLE_STALE) and not be expired (410 BUNDLE_EXPIRED); an invalid bundle needs acknowledgeErrors (409 BUNDLE_ERRORS_NOT_ACKNOWLEDGED). writes procedural_document.submitted and exhibit_filing.snapshot_created.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Procedural document id (processtuk)."},"required":true,"description":"Procedural document id (processtuk).","name":"proceduralDocumentId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"filedOn":{"type":"string","format":"date","description":"Date the lawyer filed the document with the court."},"bundleId":{"type":"string","format":"uuid","description":"Bundle that was filed; defaults to the latest non-expired bundle for this document."},"acknowledgeErrors":{"type":"boolean","description":"Required when the bundle status is invalid (409 BUNDLE_ERRORS_NOT_ACKNOWLEDGED otherwise)."},"expectedRevision":{"type":"integer","minimum":1,"description":"Revision the caller last saw; a mismatch answers 409 REVISION_CONFLICT."}},"required":["filedOn","expectedRevision"],"additionalProperties":false,"description":"Mark the party earliest draft as submitted (409 SUBMIT_ORDER_VIOLATION otherwise)."}}}},"responses":{"200":{"description":"Submitted.","content":{"application/json":{"schema":{"type":"object","properties":{"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."}},"required":["revision"],"description":"The procedure revision after the mutation."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no procedural_document.submit).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or document, or no access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"REVISION_CONFLICT, READ_ONLY, SUBMIT_ORDER_VIOLATION, BUNDLE_STALE or BUNDLE_ERRORS_NOT_ACKNOWLEDGED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"410":{"description":"BUNDLE_EXPIRED: regenerate the bundle.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/procedural-documents/{proceduralDocumentId}/reopen":{"post":{"operationId":"reopenProceduralDocument","summary":"Reopen the latest submitted procedural document of a party","description":"Returns the document to draft, supersedes its active filing (never deleted) and recomputes numbers (spec §4.4). procedural_document.reopen; only the latest submitted document of the party (409 REOPEN_NOT_ALLOWED) and only when its promotion is not pending (409 FILING_PROMOTION_PENDING). Writes procedural_document.reopened and exhibit_filing.superseded.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Procedural document id (processtuk)."},"required":true,"description":"Procedural document id (processtuk).","name":"proceduralDocumentId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["marked_in_error","court_requested_correction","other"],"description":"Reason code for reopening a submitted procedural document."},"expectedRevision":{"type":"integer","minimum":1,"description":"Revision the caller last saw; a mismatch answers 409 REVISION_CONFLICT."}},"required":["reasonCode","expectedRevision"],"additionalProperties":false,"description":"Reopen the latest submitted document of a party (409 FILING_PROMOTION_PENDING while pending)."}}}},"responses":{"200":{"description":"Reopened.","content":{"application/json":{"schema":{"type":"object","properties":{"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."}},"required":["revision"],"description":"The procedure revision after the mutation."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no procedural_document.reopen).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or document, or no access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"REVISION_CONFLICT, READ_ONLY, REOPEN_NOT_ALLOWED or FILING_PROMOTION_PENDING.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/procedures/{procedureId}/parties/{partyId}/exhibits":{"get":{"operationId":"listPartyExhibits","summary":"List the numbered exhibits of one party","description":"Exhibit list with status, rendition state, generated file names and flags (exhibit.read, spec §4.2, §7). Rows whose source document the caller cannot view are redacted to id, position, number and status. Not audited (spec §8).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Procedure id."},"required":true,"description":"Procedure id.","name":"procedureId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Party id of a procedure."},"required":true,"description":"Party id of a procedure.","name":"partyId","in":"path"}],"responses":{"200":{"description":"Numbered exhibit list.","content":{"application/json":{"schema":{"type":"object","properties":{"procedureId":{"type":"string","format":"uuid","description":"Procedure id."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."},"exhibits":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"proceduralDocumentId":{"type":"string","format":"uuid","description":"Procedural document id (processtuk)."},"position":{"type":"integer","minimum":0},"number":{"type":"integer","minimum":1,"maximum":99999},"status":{"type":"string","enum":["active","withdrawn","non_digital"],"description":"Exhibit status; withdrawn keeps its number and slot."},"redacted":{"type":"boolean","enum":[false]},"description":{"type":"string","nullable":true,"maxLength":300,"description":"Default = document title; null after a hard delete."},"descriptionIsDefault":{"type":"boolean","description":"True while the description was never edited."},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Shown as \"z.d.\" when empty."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Source document; null after a hard delete."},"documentVersionId":{"type":"string","nullable":true,"format":"uuid","description":"Pinned version; null after a hard delete."},"fileNames":{"type":"array","items":{"type":"object","properties":{"fileName":{"type":"string","maxLength":100,"pattern":"^(?<short>[A-Za-z0-9][A-Za-z0-9 ._-]{0,39}) productie (?<n>[1-9][0-9]{0,4})( deel (?<k>[1-9][0-9]?) van (?<m>[1-9][0-9]?))?\\.pdf$","description":"Generated exhibit file name; ASCII short name and numbers only."},"number":{"type":"integer","minimum":1,"maximum":99999},"partNo":{"type":"integer","nullable":true,"minimum":1,"description":"Part number, null when the exhibit is not split."},"partCount":{"type":"integer","minimum":1,"maximum":99,"description":"Total parts (1 when not split)."},"pageFrom":{"type":"integer","nullable":true,"minimum":1,"description":"First page of the part, null when unknown or not split."},"pageTo":{"type":"integer","nullable":true,"minimum":1,"description":"Last page of the part, null when unknown or not split."}},"required":["fileName","number","partNo","partCount","pageFrom","pageTo"],"description":"One file of an exhibit (one entry when not split)."},"description":"Generated names (empty for a non-digital exhibit)."},"renditionStatus":{"type":"string","nullable":true,"enum":["pending","processing","ready","failed","purged",null],"description":"Null for a non-digital exhibit."},"renditionFailureCode":{"type":"string","nullable":true,"enum":["UNSUPPORTED_TYPE","PASSWORD_PROTECTED","UNREADABLE","PDFA_VALIDATION_FAILED","PAGE_TOO_LARGE","PART_COUNT_EXCEEDED","CONVERSION_TIMEOUT","CONVERSION_RESOURCE_LIMIT","SOURCE_NOT_CLEAN",null],"description":"Rendition failure code; safe to log (no content)."},"renditionWarningCodes":{"type":"array","items":{"type":"string","enum":["SIGNATURE_INVALIDATED","ATTACHMENTS_REMOVED","VALIDATOR_BASIC"],"description":"Rendition warning code; mapped to NL/EN UI texts."}},"newerVersionAvailable":{"type":"boolean","description":"A newer source version with a different blob exists."},"sourceInTrash":{"type":"boolean","description":"The pinned source is in the trash; the bundle still builds."},"internalSource":{"type":"boolean","description":"The source is in an internal counsel area (warning PR-W05)."},"provisional":{"type":"boolean","description":"True when an earlier draft of the party shifts these numbers (PR-W08)."},"withdrawnReasonCode":{"type":"string","nullable":true,"enum":["not_relied_on","replaced","filed_in_error","other",null],"description":"Withdrawal reason code."},"nonDigitalReason":{"type":"string","nullable":true,"enum":["audio_video","physical_object","other",null],"description":"Reason a non-digital exhibit has no file; audio/video is sent separately."}},"required":["id","proceduralDocumentId","position","number","status","redacted","description","descriptionIsDefault","documentDate","documentId","documentVersionId","fileNames","renditionStatus","renditionFailureCode","renditionWarningCodes","newerVersionAvailable","sourceInTrash","internalSource","provisional","withdrawnReasonCode","nonDigitalReason"],"description":"Full exhibit row with names, pins, rendition state and flags."},{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"proceduralDocumentId":{"type":"string","format":"uuid","description":"Procedural document id (processtuk)."},"position":{"type":"integer","minimum":0,"description":"Order inside the procedural document (0-based)."},"number":{"type":"integer","minimum":1,"maximum":99999},"status":{"type":"string","enum":["active","withdrawn","non_digital"],"description":"Exhibit status; withdrawn keeps its number and slot."},"redacted":{"type":"boolean","enum":[true],"description":"Always true: the source document is not viewable for this caller."}},"required":["id","proceduralDocumentId","position","number","status","redacted"],"additionalProperties":false,"description":"Redacted exhibit row: no description, date, ids of the source, file names or rendition state."}],"description":"Exhibit list row: full for viewable sources, redacted for hidden ones."},"description":"Numbered list, ordered by number."}},"required":["procedureId","partyId","revision","exhibits"],"description":"Numbered exhibit list of one party (not audited, spec §8)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, procedure or party, or no access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/procedural-documents/{proceduralDocumentId}/exhibits":{"post":{"operationId":"addExhibits","summary":"Add exhibits to a draft procedural document","description":"Bulk add (spec §4.7); each source must be in the same room (404 DOCUMENT_NOT_FOUND) and have an AVAILABLE CLEAN version (409 DOCUMENT_NOT_READY). An internal-counsel source needs confirmInternalSource (422 INTERNAL_SOURCE_NOT_CONFIRMED). exhibit.manage; writes exhibit.added per item plus exhibit.renumbered.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Procedural document id (processtuk)."},"required":true,"description":"Procedural document id (processtuk).","name":"proceduralDocumentId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid","description":"Source document in the same room (404 DOCUMENT_NOT_FOUND otherwise)."},"description":{"type":"string","minLength":1,"maxLength":300,"description":"Defaults to the document title, never the file name."},"documentDate":{"type":"string","format":"date"},"position":{"type":"integer","minimum":0,"description":"Insert position in the draft; defaults to the end."}},"required":["documentId"],"additionalProperties":false,"description":"One exhibit to add to a draft procedural document."},"minItems":1,"maxItems":200,"description":"Bulk add; one exhibit.added event per item."},"confirmInternalSource":{"type":"boolean","description":"Required when a source sits in an internal counsel area (422 INTERNAL_SOURCE_NOT_CONFIRMED)."},"expectedRevision":{"type":"integer","minimum":1,"description":"Revision the caller last saw; a mismatch answers 409 REVISION_CONFLICT."}},"required":["items","expectedRevision"],"additionalProperties":false,"description":"Add exhibits to a draft procedural document."}}}},"responses":{"201":{"description":"Added.","content":{"application/json":{"schema":{"type":"object","properties":{"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."}},"required":["revision"],"description":"The procedure revision after the mutation."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no exhibit.manage).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, document or source document, or no access. DOCUMENT_NOT_FOUND: a source is in another room or tenant, or not readable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"REVISION_CONFLICT, READ_ONLY or DOCUMENT_NOT_READY.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"422":{"description":"NUMBER_OUT_OF_RANGE (spec X33) or INTERNAL_SOURCE_NOT_CONFIRMED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/exhibits/{exhibitId}":{"patch":{"operationId":"updateExhibit","summary":"Patch an exhibit: description, date, pin or non-digital","description":"Edits the description or document date, repins to a version of the same document (404 DOCUMENT_NOT_FOUND) or marks the exhibit non-digital. exhibit.manage; a repin after submission answers 409 EXHIBIT_SUBMITTED. Writes exhibit.updated, exhibit.repinned or exhibit.marked_non_digital, one per kind of change.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"required":true,"description":"Exhibit id (productie).","name":"exhibitId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","minLength":1,"maxLength":300},"documentDate":{"type":"string","nullable":true,"format":"date"},"documentVersionId":{"type":"string","format":"uuid","description":"Repin to a version of the exhibit own document (404 DOCUMENT_NOT_FOUND otherwise)."},"status":{"type":"string","enum":["non_digital"],"description":"Mark the exhibit non-digital; no other status transition is available here."},"nonDigitalReason":{"type":"string","enum":["audio_video","physical_object","other"],"description":"Required together with status non_digital."},"expectedRevision":{"type":"integer","minimum":1,"description":"Revision the caller last saw; a mismatch answers 409 REVISION_CONFLICT."}},"additionalProperties":false,"description":"Patch an exhibit: description, document date, repin or mark non-digital."}}}},"responses":{"200":{"description":"Updated row.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"proceduralDocumentId":{"type":"string","format":"uuid","description":"Procedural document id (processtuk)."},"position":{"type":"integer","minimum":0},"number":{"type":"integer","minimum":1,"maximum":99999},"status":{"type":"string","enum":["active","withdrawn","non_digital"],"description":"Exhibit status; withdrawn keeps its number and slot."},"redacted":{"type":"boolean","enum":[false]},"description":{"type":"string","nullable":true,"maxLength":300,"description":"Default = document title; null after a hard delete."},"descriptionIsDefault":{"type":"boolean","description":"True while the description was never edited."},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Shown as \"z.d.\" when empty."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Source document; null after a hard delete."},"documentVersionId":{"type":"string","nullable":true,"format":"uuid","description":"Pinned version; null after a hard delete."},"fileNames":{"type":"array","items":{"type":"object","properties":{"fileName":{"type":"string","maxLength":100,"pattern":"^(?<short>[A-Za-z0-9][A-Za-z0-9 ._-]{0,39}) productie (?<n>[1-9][0-9]{0,4})( deel (?<k>[1-9][0-9]?) van (?<m>[1-9][0-9]?))?\\.pdf$","description":"Generated exhibit file name; ASCII short name and numbers only."},"number":{"type":"integer","minimum":1,"maximum":99999},"partNo":{"type":"integer","nullable":true,"minimum":1,"description":"Part number, null when the exhibit is not split."},"partCount":{"type":"integer","minimum":1,"maximum":99,"description":"Total parts (1 when not split)."},"pageFrom":{"type":"integer","nullable":true,"minimum":1,"description":"First page of the part, null when unknown or not split."},"pageTo":{"type":"integer","nullable":true,"minimum":1,"description":"Last page of the part, null when unknown or not split."}},"required":["fileName","number","partNo","partCount","pageFrom","pageTo"],"description":"One file of an exhibit (one entry when not split)."},"description":"Generated names (empty for a non-digital exhibit)."},"renditionStatus":{"type":"string","nullable":true,"enum":["pending","processing","ready","failed","purged",null],"description":"Null for a non-digital exhibit."},"renditionFailureCode":{"type":"string","nullable":true,"enum":["UNSUPPORTED_TYPE","PASSWORD_PROTECTED","UNREADABLE","PDFA_VALIDATION_FAILED","PAGE_TOO_LARGE","PART_COUNT_EXCEEDED","CONVERSION_TIMEOUT","CONVERSION_RESOURCE_LIMIT","SOURCE_NOT_CLEAN",null],"description":"Rendition failure code; safe to log (no content)."},"renditionWarningCodes":{"type":"array","items":{"type":"string","enum":["SIGNATURE_INVALIDATED","ATTACHMENTS_REMOVED","VALIDATOR_BASIC"],"description":"Rendition warning code; mapped to NL/EN UI texts."}},"newerVersionAvailable":{"type":"boolean","description":"A newer source version with a different blob exists."},"sourceInTrash":{"type":"boolean","description":"The pinned source is in the trash; the bundle still builds."},"internalSource":{"type":"boolean","description":"The source is in an internal counsel area (warning PR-W05)."},"provisional":{"type":"boolean","description":"True when an earlier draft of the party shifts these numbers (PR-W08)."},"withdrawnReasonCode":{"type":"string","nullable":true,"enum":["not_relied_on","replaced","filed_in_error","other",null],"description":"Withdrawal reason code."},"nonDigitalReason":{"type":"string","nullable":true,"enum":["audio_video","physical_object","other",null],"description":"Reason a non-digital exhibit has no file; audio/video is sent separately."},"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."}},"required":["id","proceduralDocumentId","position","number","status","redacted","description","descriptionIsDefault","documentDate","documentId","documentVersionId","fileNames","renditionStatus","renditionFailureCode","renditionWarningCodes","newerVersionAvailable","sourceInTrash","internalSource","provisional","withdrawnReasonCode","nonDigitalReason","revision"],"description":"Updated exhibit row with the procedure revision after the mutation."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no exhibit.manage).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, exhibit or document, or no access. DOCUMENT_NOT_FOUND: the repin target is in another room or tenant, or not readable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"REVISION_CONFLICT, READ_ONLY or EXHIBIT_SUBMITTED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"delete":{"operationId":"removeExhibit","summary":"Remove an exhibit from a draft","description":"Draft only (409 EXHIBIT_SUBMITTED otherwise; use withdraw on a submitted document). Closes the number gap for the following draft exhibits. exhibit.manage; writes exhibit.removed and exhibit.renumbered.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"required":true,"description":"Exhibit id (productie).","name":"exhibitId","in":"path"}],"responses":{"200":{"description":"Removed; returns the updated revision.","content":{"application/json":{"schema":{"type":"object","properties":{"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."}},"required":["revision"],"description":"The procedure revision after the mutation."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no exhibit.manage).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or exhibit, or no access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"REVISION_CONFLICT, READ_ONLY or EXHIBIT_SUBMITTED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/exhibits/{exhibitId}/withdraw":{"post":{"operationId":"withdrawExhibit","summary":"Withdraw a submitted exhibit","description":"Submitted documents only (409 EXHIBIT_NOT_SUBMITTED on a draft; remove it instead). The number is kept and never reused (spec §4.4). exhibit.manage; writes exhibit.withdrawn with the reason code.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"required":true,"description":"Exhibit id (productie).","name":"exhibitId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["not_relied_on","replaced","filed_in_error","other"],"description":"Withdrawal reason code."},"expectedRevision":{"type":"integer","minimum":1,"description":"Revision the caller last saw; a mismatch answers 409 REVISION_CONFLICT."}},"required":["reasonCode","expectedRevision"],"additionalProperties":false,"description":"Withdraw an exhibit of a submitted document; its number is kept and never reused."}}}},"responses":{"200":{"description":"Withdrawn.","content":{"application/json":{"schema":{"type":"object","properties":{"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."}},"required":["revision"],"description":"The procedure revision after the mutation."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no exhibit.manage).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or exhibit, or no access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"REVISION_CONFLICT, READ_ONLY or EXHIBIT_NOT_SUBMITTED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/procedural-documents/{proceduralDocumentId}/exhibit-order":{"put":{"operationId":"reorderExhibits","summary":"Replace the exhibit order inside a draft","description":"The body must be a permutation of the document exhibits (422 ORDER_NOT_PERMUTATION). exhibit.manage; writes exhibit.reordered and exhibit.renumbered when numbers changed.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Procedural document id (processtuk)."},"required":true,"description":"Procedural document id (processtuk).","name":"proceduralDocumentId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"exhibitIds":{"type":"array","items":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"minItems":1,"description":"New order; must be a permutation of the document exhibits (422 ORDER_NOT_PERMUTATION)."},"expectedRevision":{"type":"integer","minimum":1,"description":"Revision the caller last saw; a mismatch answers 409 REVISION_CONFLICT."}},"required":["exhibitIds","expectedRevision"],"additionalProperties":false,"description":"Replace the exhibit order inside one draft procedural document."}}}},"responses":{"200":{"description":"Reordered.","content":{"application/json":{"schema":{"type":"object","properties":{"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."}},"required":["revision"],"description":"The procedure revision after the mutation."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no exhibit.manage).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or document, or no access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"REVISION_CONFLICT or READ_ONLY.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"422":{"description":"ORDER_NOT_PERMUTATION.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/exhibits/{exhibitId}/move":{"post":{"operationId":"moveExhibit","summary":"Move an exhibit to another draft of the same party","description":"Target must be a draft of the same party (422 PARTY_MISMATCH). exhibit.manage; writes exhibit.moved and exhibit.renumbered when numbers changed.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"required":true,"description":"Exhibit id (productie).","name":"exhibitId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"toProceduralDocumentId":{"type":"string","format":"uuid","description":"Target draft of the same party."},"position":{"type":"integer","minimum":0,"description":"Order inside the target document."},"expectedRevision":{"type":"integer","minimum":1,"description":"Revision the caller last saw; a mismatch answers 409 REVISION_CONFLICT."}},"required":["toProceduralDocumentId","position","expectedRevision"],"additionalProperties":false,"description":"Move an exhibit to another draft document of the same party (422 PARTY_MISMATCH otherwise)."}}}},"responses":{"200":{"description":"Moved.","content":{"application/json":{"schema":{"type":"object","properties":{"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."}},"required":["revision"],"description":"The procedure revision after the mutation."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no exhibit.manage).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, exhibit or target document, or no access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"REVISION_CONFLICT or READ_ONLY.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"422":{"description":"PARTY_MISMATCH.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/exhibits/{exhibitId}/rendition/retry":{"post":{"operationId":"retryExhibitRendition","summary":"Retry a failed exhibit rendition","description":"Only a failed rendition can be retried (409 RENDITION_NOT_FAILED); increments the attempt and enqueues exhibit.render with new derivative UUIDs (spec §6.7). exhibit.manage; writes exhibit_rendition.retry_requested.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"required":true,"description":"Exhibit id (productie).","name":"exhibitId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"expectedRevision":{"type":"integer","minimum":1,"description":"Optional guard; a mismatch answers 409 REVISION_CONFLICT."}},"additionalProperties":false,"description":"Retry a failed rendition; expectedRevision is optional (spec §4.9)."}}}},"responses":{"200":{"description":"Retry queued.","content":{"application/json":{"schema":{"type":"object","properties":{"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."}},"required":["revision"],"description":"The procedure revision after the mutation."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no exhibit.manage).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or exhibit, or no access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"READ_ONLY or RENDITION_NOT_FAILED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/procedure-parties/{partyId}/bundles":{"post":{"operationId":"createExhibitBundle","summary":"Build a Mijn Rechtspraak-ready bundle","description":"Creates a queued bundle and enqueues exhibit.bundle.build (spec §9.4). exhibit.bundle.create plus read: download on every included source, else 403 listing the exhibit IDs that lack it (spec §7). Answers 202 with the queued bundle; writes exhibit_bundle.created when the build finishes.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Party id of a procedure."},"required":true,"description":"Party id of a procedure.","name":"partyId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"scope":{"type":"string","enum":["procedural_document","cumulative"],"description":"Bundle scope: one procedural document, or all exhibits up to and including one."},"proceduralDocumentId":{"type":"string","format":"uuid","description":"Required when scope is procedural_document."},"options":{"type":"object","properties":{"indexLanguage":{"type":"string","enum":["nl","en"],"description":"Index labels; file names always Dutch."},"includeProceduralDocument":{"type":"boolean","description":"Include the linked processtuk PDF/A in `indienen/`."}},"required":["indexLanguage","includeProceduralDocument"],"additionalProperties":false,"description":"Bundle options (spec §3.1 options jsonb)."}},"required":["scope","options"],"additionalProperties":false,"description":"Build a bundle; answers 202 with the queued bundle."}}}},"responses":{"202":{"description":"Bundle queued.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Exhibit bundle id."},"procedureId":{"type":"string","format":"uuid","description":"Procedure id."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"scope":{"type":"string","enum":["procedural_document","cumulative"],"description":"Bundle scope: one procedural document, or all exhibits up to and including one."},"proceduralDocumentId":{"type":"string","nullable":true,"format":"uuid","description":"Procedural document id (processtuk)."},"options":{"type":"object","properties":{"indexLanguage":{"type":"string","enum":["nl","en"],"description":"Index labels; file names always Dutch."},"includeProceduralDocument":{"type":"boolean","description":"Include the linked processtuk PDF/A in `indienen/`."}},"required":["indexLanguage","includeProceduralDocument"],"additionalProperties":false,"description":"Bundle options (spec §3.1 options jsonb)."},"status":{"type":"string","enum":["queued","building","ready","ready_with_warnings","invalid","failed","expired"],"description":"Bundle build status; invalid bundles need explicit acknowledgement to submit or download."},"sizeBytes":{"type":"integer","nullable":true,"minimum":0},"sha256":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the ZIP, null until ready."},"validationSummary":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["PR-E01","PR-E02","PR-E03","PR-E04","PR-E05","PR-E06","PR-E07","PR-E08","PR-E09","PR-E10","PR-E11","PR-E12","PR-E13","PR-E14","PR-E15","PR-W01","PR-W02","PR-W03","PR-W04","PR-W05","PR-W06","PR-W07","PR-W08","PR-W09","PR-W10","PR-W11","PR-W12"],"description":"Bundle validation code (spec §10); codes and IDs only, never content."},"severity":{"type":"string","enum":["error","warning"],"description":"Validation finding severity: error makes the bundle invalid."},"exhibitId":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"partNo":{"type":"integer","minimum":1,"maximum":99}},"required":["code","severity"],"additionalProperties":false,"description":"One bundle validation finding; never carries names or descriptions."}},"procedureRevision":{"type":"integer","minimum":1,"description":"Revision the bundle was built from; older means stale."},"createdAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time","description":"createdAt + 7 days (STORAGE §4)."}},"required":["id","procedureId","partyId","scope","proceduralDocumentId","options","status","sizeBytes","sha256","validationSummary","procedureRevision","createdAt","expiresAt"],"description":"Status and validation summary of one bundle."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no exhibit.bundle.create, or a source without read: download).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, party or document, or no access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"READ_ONLY: the room or procedure is not active.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/procedure-parties/{partyId}/bundle-preview":{"get":{"operationId":"previewExhibitBundle","summary":"Dry-run bundle validation with generated names and index rows","description":"Returns findings, file names and index rows without writing a ZIP (spec §10, §11). This is a read-export and is audited (exhibit_bundle.previewed); it needs exhibit.bundle.create plus read: download on every included source.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Party id of a procedure."},"required":true,"description":"Party id of a procedure.","name":"partyId","in":"path"},{"schema":{"type":"string","enum":["procedural_document","cumulative"],"description":"Bundle scope: one procedural document, or all exhibits up to and including one."},"required":true,"description":"Bundle scope: one procedural document, or all exhibits up to and including one.","name":"scope","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Procedural document id (processtuk)."},"required":false,"description":"Procedural document id (processtuk).","name":"proceduralDocumentId","in":"query"}],"responses":{"200":{"description":"Dry-run result.","content":{"application/json":{"schema":{"type":"object","properties":{"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"scope":{"type":"string","enum":["procedural_document","cumulative"],"description":"Bundle scope: one procedural document, or all exhibits up to and including one."},"proceduralDocumentId":{"type":"string","nullable":true,"format":"uuid","description":"Procedural document id (processtuk)."},"exhibitCount":{"type":"integer","minimum":0},"errorCount":{"type":"integer","minimum":0},"warningCount":{"type":"integer","minimum":0},"files":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","maxLength":300,"description":"Path inside the ZIP, e.g. `indienen/Jansen productie 9.pdf`."},"bytes":{"type":"integer","minimum":0},"sha256":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$"},"pages":{"type":"integer","nullable":true,"minimum":0},"exhibitNumber":{"type":"integer","nullable":true,"minimum":1,"maximum":99999},"partNo":{"type":"integer","nullable":true,"minimum":1,"maximum":99}},"required":["path","bytes","sha256","pages","exhibitNumber","partNo"],"description":"One previewed file; generated name, size and hash."}},"findings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["PR-E01","PR-E02","PR-E03","PR-E04","PR-E05","PR-E06","PR-E07","PR-E08","PR-E09","PR-E10","PR-E11","PR-E12","PR-E13","PR-E14","PR-E15","PR-W01","PR-W02","PR-W03","PR-W04","PR-W05","PR-W06","PR-W07","PR-W08","PR-W09","PR-W10","PR-W11","PR-W12"],"description":"Bundle validation code (spec §10); codes and IDs only, never content."},"severity":{"type":"string","enum":["error","warning"],"description":"Validation finding severity: error makes the bundle invalid."},"exhibitId":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"partNo":{"type":"integer","minimum":1,"maximum":99}},"required":["code","severity"],"additionalProperties":false,"description":"One bundle validation finding; never carries names or descriptions."}},"index":{"type":"object","properties":{"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"scope":{"type":"string","enum":["procedural_document","cumulative"],"description":"Bundle scope: one procedural document, or all exhibits up to and including one."},"proceduralDocumentId":{"type":"string","nullable":true,"format":"uuid","description":"Procedural document id (processtuk)."},"language":{"type":"string","enum":["nl","en"],"description":"Index label language; descriptions are shown as entered."},"header":{"type":"object","properties":{"court":{"type":"string","maxLength":200},"caseNumber":{"type":"string","nullable":true,"maxLength":100,"description":"Null renders \"zaaknummer nog niet bekend\"."},"procedureTitle":{"type":"string","maxLength":300},"partyDisplayName":{"type":"string","maxLength":200},"partyRole":{"type":"string","enum":["claimant","defendant","applicant","respondent","interested_party","appellant","respondent_on_appeal","intervener","joined_party"],"description":"Role of a party in the procedure."},"titleKey":{"type":"string","enum":["exhibits.index.title"],"description":"i18n key of the index title (\"Productieoverzicht\" / \"Exhibit index\")."},"scopeLineKey":{"type":"string","enum":["exhibits.index.scope"],"description":"i18n key of the scope line; the values are the document label or \"tot en met productie n\"."},"scopeLineValue":{"type":"string","nullable":true,"maxLength":300,"description":"Pre-formatted scope value (document label or last number); language-independent data."},"generatedAt":{"type":"string","format":"date-time"},"language":{"type":"string","enum":["nl","en"],"description":"Index label language; descriptions are shown as entered."}},"required":["court","caseNumber","procedureTitle","partyDisplayName","partyRole","titleKey","scopeLineKey","scopeLineValue","generatedAt","language"],"description":"Header block of the exhibit index."},"sections":{"type":"array","items":{"type":"object","properties":{"proceduralDocumentId":{"type":"string","format":"uuid","description":"Procedural document id (processtuk)."},"kind":{"type":"string","enum":["summons","statement_of_defence","reply","rejoinder","counterclaim_reply","deed_of_production","deed_of_response","deed_other","hearing_documents","interlocutory_motion","application","statement_of_response","statement_of_appeal","statement_of_response_on_appeal","other"],"description":"Kind of procedural document (processtuk)."},"title":{"type":"string","nullable":true,"maxLength":300},"status":{"type":"string","enum":["draft","submitted"],"description":"Procedural document status: only drafts can be reordered or edited."},"filedOn":{"type":"string","nullable":true,"format":"date"},"rows":{"type":"array","items":{"type":"object","properties":{"exhibitId":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"number":{"type":"integer","minimum":1,"maximum":99999},"description":{"type":"string","nullable":true,"maxLength":300},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Null renders \"z.d.\" / \"n.d.\"."},"pageCount":{"type":"integer","nullable":true,"minimum":0,"description":"Total pages; null for a non-digital exhibit."},"introducedWith":{"type":"string","format":"uuid","description":"Procedural document label source; omitted in single-document scope."},"fileNames":{"type":"array","items":{"type":"string","maxLength":100,"pattern":"^(?<short>[A-Za-z0-9][A-Za-z0-9 ._-]{0,39}) productie (?<n>[1-9][0-9]{0,4})( deel (?<k>[1-9][0-9]?) van (?<m>[1-9][0-9]?))?\\.pdf$","description":"Generated exhibit file name; ASCII short name and numbers only."},"description":"Generated names, parts on separate lines."},"remarks":{"type":"array","items":{"type":"string","enum":["withdrawn","split","delivered_separately","physical_object"],"description":"Remark code rendered in the index; texts come from packages/i18n."}}},"required":["exhibitId","number","description","documentDate","pageCount","fileNames","remarks"],"description":"One index row."}}},"required":["proceduralDocumentId","kind","title","status","filedOn","rows"],"description":"Index section: one procedural document with its exhibits."},"minItems":1}},"required":["partyId","scope","proceduralDocumentId","language","header","sections"],"description":"Index rows the bundle would contain; audited as a read-export."}},"required":["partyId","scope","proceduralDocumentId","exhibitCount","errorCount","warningCount","files","findings","index"],"description":"Dry-run bundle preview: files, index rows and findings."}}}},"400":{"description":"Invalid scope or missing proceduralDocumentId.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no exhibit.bundle.create, or a source without read: download).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, party or document, or no access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/bundles/{bundleId}":{"get":{"operationId":"getExhibitBundle","summary":"Read bundle status and validation summary","description":"Status and the validation summary (codes and IDs only). Current rights are re-checked on every request: having created the bundle grants nothing (spec §7). exhibit.bundle.read; not audited.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Exhibit bundle id."},"required":true,"description":"Exhibit bundle id.","name":"bundleId","in":"path"}],"responses":{"200":{"description":"Bundle status.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Exhibit bundle id."},"procedureId":{"type":"string","format":"uuid","description":"Procedure id."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"scope":{"type":"string","enum":["procedural_document","cumulative"],"description":"Bundle scope: one procedural document, or all exhibits up to and including one."},"proceduralDocumentId":{"type":"string","nullable":true,"format":"uuid","description":"Procedural document id (processtuk)."},"options":{"type":"object","properties":{"indexLanguage":{"type":"string","enum":["nl","en"],"description":"Index labels; file names always Dutch."},"includeProceduralDocument":{"type":"boolean","description":"Include the linked processtuk PDF/A in `indienen/`."}},"required":["indexLanguage","includeProceduralDocument"],"additionalProperties":false,"description":"Bundle options (spec §3.1 options jsonb)."},"status":{"type":"string","enum":["queued","building","ready","ready_with_warnings","invalid","failed","expired"],"description":"Bundle build status; invalid bundles need explicit acknowledgement to submit or download."},"sizeBytes":{"type":"integer","nullable":true,"minimum":0},"sha256":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the ZIP, null until ready."},"validationSummary":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["PR-E01","PR-E02","PR-E03","PR-E04","PR-E05","PR-E06","PR-E07","PR-E08","PR-E09","PR-E10","PR-E11","PR-E12","PR-E13","PR-E14","PR-E15","PR-W01","PR-W02","PR-W03","PR-W04","PR-W05","PR-W06","PR-W07","PR-W08","PR-W09","PR-W10","PR-W11","PR-W12"],"description":"Bundle validation code (spec §10); codes and IDs only, never content."},"severity":{"type":"string","enum":["error","warning"],"description":"Validation finding severity: error makes the bundle invalid."},"exhibitId":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"partNo":{"type":"integer","minimum":1,"maximum":99}},"required":["code","severity"],"additionalProperties":false,"description":"One bundle validation finding; never carries names or descriptions."}},"procedureRevision":{"type":"integer","minimum":1,"description":"Revision the bundle was built from; older means stale."},"createdAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time","description":"createdAt + 7 days (STORAGE §4)."}},"required":["id","procedureId","partyId","scope","proceduralDocumentId","options","status","sizeBytes","sha256","validationSummary","procedureRevision","createdAt","expiresAt"],"description":"Status and validation summary of one bundle."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no exhibit.bundle.read, or a source without read: download).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or bundle, or no access (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/bundles/{bundleId}/download":{"get":{"operationId":"downloadExhibitBundle","summary":"Download the bundle ZIP","description":"Streams and decrypts the ZIP chunk by chunk with Cache-Control: no-store and a sanitised Content-Disposition (spec §9.4); a stored file that does not match its recorded SHA-256 aborts the response before the last bytes. Current rights are re-checked on every request against the bundle's own content manifest (the documents it was built from): a source without read: download, or an included source deleted since the build, is 403; a bundle without a manifest (built before it existed) is 409 and must be regenerated. An invalid bundle needs acknowledgeErrors=true (409 BUNDLE_ERRORS_NOT_ACKNOWLEDGED), an expired one answers 410. Downloads are limited per principal (429 RATE_LIMITED with Retry-After). Writes exhibit_bundle.downloaded with the acknowledgement flag.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Exhibit bundle id."},"required":true,"description":"Exhibit bundle id.","name":"bundleId","in":"path"},{"schema":{"type":"string","enum":["true","false"],"description":"Required as \"true\" for an invalid bundle (409 BUNDLE_ERRORS_NOT_ACKNOWLEDGED otherwise)."},"required":false,"description":"Required as \"true\" for an invalid bundle (409 BUNDLE_ERRORS_NOT_ACKNOWLEDGED otherwise).","name":"acknowledgeErrors","in":"query"}],"responses":{"200":{"description":"Bundle ZIP (application/zip).","content":{"application/zip":{"schema":{"type":"string","description":"Encrypted-then-streamed bundle ZIP bytes."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no exhibit.bundle.download, or a source without read: download).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or bundle, or no access (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"BUNDLE_ERRORS_NOT_ACKNOWLEDGED, or CONFLICT (not built, or no content manifest).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"410":{"description":"BUNDLE_EXPIRED: regenerate the bundle.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"RATE_LIMITED: too many downloads for this principal.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"AUDIT_UNAVAILABLE: the audit event could not be written; nothing was served (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/procedure-parties/{partyId}/exhibit-index":{"post":{"operationId":"createExhibitIndex","summary":"Generate the exhibit index (PDF or editable DOCX)","description":"Creates a queued index export and enqueues exhibit.index.build (spec §9.4). exhibit.index.generate plus read: download on every included source. Answers 202 with the export; writes exhibit_index.generated when the build finishes. The DOCX copy is not placed in indienen/.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Party id of a procedure."},"required":true,"description":"Party id of a procedure.","name":"partyId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"format":{"type":"string","enum":["pdf","docx"],"description":"Index export format."},"scope":{"type":"string","enum":["procedural_document","cumulative"],"description":"Bundle scope: one procedural document, or all exhibits up to and including one."},"proceduralDocumentId":{"type":"string","format":"uuid","description":"Required when scope is procedural_document; for cumulative the last document included."},"language":{"type":"string","enum":["nl","en"],"description":"Index label language; descriptions are shown as entered."}},"required":["format","scope","language"],"additionalProperties":false,"description":"Generate the exhibit index (PDF or editable DOCX) for a party."}}}},"responses":{"202":{"description":"Index export queued.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The exportId in the API."},"procedureId":{"type":"string","format":"uuid","description":"Procedure id."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"scope":{"type":"string","enum":["procedural_document","cumulative"],"description":"Bundle scope: one procedural document, or all exhibits up to and including one."},"proceduralDocumentId":{"type":"string","nullable":true,"format":"uuid","description":"Procedural document id (processtuk)."},"format":{"type":"string","enum":["pdf","docx"],"description":"Index export format."},"language":{"type":"string","enum":["nl","en"],"description":"Index label language; descriptions are shown as entered."},"status":{"type":"string","enum":["queued","building","ready","failed","expired"],"description":"Index export status."},"sizeBytes":{"type":"integer","nullable":true,"minimum":0},"sha256":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the exported file, null until ready."},"procedureRevision":{"type":"integer","minimum":1,"description":"Revision the index was generated from."},"createdAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time","description":"createdAt + 7 days (STORAGE §4)."}},"required":["id","procedureId","partyId","scope","proceduralDocumentId","format","language","status","sizeBytes","sha256","procedureRevision","createdAt","expiresAt"],"description":"Index export status (downloads re-check current rights, spec §7)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no exhibit.index.generate, or a source without read: download).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, party or document, or no access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"READ_ONLY: the room or procedure is not active.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/exhibit-index-exports/{exportId}":{"get":{"operationId":"getExhibitIndexExport","summary":"Read index export status","description":"Status of one index export. Current rights are re-checked (spec §7). exhibit.index.read; not audited.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Exhibit index export id."},"required":true,"description":"Exhibit index export id.","name":"exportId","in":"path"}],"responses":{"200":{"description":"Export status.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The exportId in the API."},"procedureId":{"type":"string","format":"uuid","description":"Procedure id."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"scope":{"type":"string","enum":["procedural_document","cumulative"],"description":"Bundle scope: one procedural document, or all exhibits up to and including one."},"proceduralDocumentId":{"type":"string","nullable":true,"format":"uuid","description":"Procedural document id (processtuk)."},"format":{"type":"string","enum":["pdf","docx"],"description":"Index export format."},"language":{"type":"string","enum":["nl","en"],"description":"Index label language; descriptions are shown as entered."},"status":{"type":"string","enum":["queued","building","ready","failed","expired"],"description":"Index export status."},"sizeBytes":{"type":"integer","nullable":true,"minimum":0},"sha256":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the exported file, null until ready."},"procedureRevision":{"type":"integer","minimum":1,"description":"Revision the index was generated from."},"createdAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time","description":"createdAt + 7 days (STORAGE §4)."}},"required":["id","procedureId","partyId","scope","proceduralDocumentId","format","language","status","sizeBytes","sha256","procedureRevision","createdAt","expiresAt"],"description":"Index export status (downloads re-check current rights, spec §7)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no exhibit.index.read, or a source without read: download).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or export, or no access (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/exhibit-index-exports/{exportId}/download":{"get":{"operationId":"downloadExhibitIndexExport","summary":"Download the generated exhibit index","description":"Streams the PDF or DOCX index from the exports bucket after re-checking current rights (spec §9.4). exhibit.index.generate; writes exhibit_index.downloaded with the hash.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Exhibit index export id."},"required":true,"description":"Exhibit index export id.","name":"exportId","in":"path"}],"responses":{"200":{"description":"Index file (application/pdf or DOCX).","content":{"application/pdf":{"schema":{"type":"string","description":"Generated PDF/A index bytes."}},"application/vnd.openxmlformats-officedocument.wordprocessingml.document":{"schema":{"type":"string","description":"Generated editable DOCX index bytes."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no exhibit.index.generate, or a source without read: download).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or export, or no access (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"CONFLICT: not built yet, or no content manifest (regenerate).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"410":{"description":"Export expired (7 days); regenerate the index.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"RATE_LIMITED: too many downloads for this principal.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"AUDIT_UNAVAILABLE: the audit event could not be written; nothing was served (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/key-rotation/master-rewrap":{"post":{"operationId":"startKeyRotationMasterRewrap","summary":"Start a KMS master-key re-wrap run","description":"Queues a resumable re-wrap of every KEK to the current KMS master version (T-260916-9083, SEC-02, ADR-0004 D7). Requires key.rotation.master_rewrap (firm admins, step-up) and the four-eyes block requestedBy/approvedBy/incidentRef. Emits room_key.master_rewrapped per batch. No key material in the request, response or audit payloads.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"incidentRef":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$","description":"Opaque incident record reference."},"requestedBy":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9._:+-]{0,127}$","description":"Operator who requested the run."},"approvedBy":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9._:+-]{0,127}$","description":"Second operator; must differ from requestedBy."},"kmsKeyId":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:+/=-]{0,254}$","description":"KMS key id whose rows are re-wrapped."},"targetKmsVersion":{"type":"string","pattern":"^\\d{1,10}$","description":"KMS master version to re-wrap to."},"batchSize":{"type":"integer","minimum":1,"maximum":10000,"description":"Rows per resumable batch (worker default when omitted)."}},"required":["incidentRef","requestedBy","approvedBy","kmsKeyId","targetKmsVersion"],"additionalProperties":false,"description":"Start a KMS master-key re-wrap run (ADR-0004 D7)."}}}},"responses":{"202":{"description":"Run queued for a worker.","content":{"application/json":{"schema":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","description":"Server-generated run id (also in the audit event)."},"job":{"type":"string","enum":["master_rewrap","recovery_rewrap","room_rotate"],"description":"Rotation job: re-wrap the KMS master key, the recovery shares, or one room key."},"status":{"type":"string","enum":["queued"],"description":"The run is queued for a worker."}},"required":["runId","job","status"],"description":"Queued key-rotation run."}}}},"400":{"description":"Invalid body (unknown keys, malformed ids or versions).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out, or a fresh second factor is required (STEP_UP_REQUIRED on a stale session).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: the principal lacks the rotation action (non-admins), or the caller is neither of the two named operators.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Four-eyes refused: requestedBy and approvedBy are the same operator.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"No queue is available to run the rotation (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/key-rotation/recovery-rewrap":{"post":{"operationId":"startKeyRotationRecoveryRewrap","summary":"Start a recovery-share re-wrap run","description":"Queues a resumable re-wrap of every KEK to a new recovery recipient (T-260916-9083, SEC-02, ADR-0004 D7). Requires key.rotation.recovery_rewrap (firm admins, step-up) and the four-eyes block. Emits room_key.recovery_rewrapped per batch. Carries the recipient fingerprint, never the share.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"incidentRef":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$","description":"Opaque incident record reference."},"requestedBy":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9._:+-]{0,127}$","description":"Operator who requested the run."},"approvedBy":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9._:+-]{0,127}$","description":"Second operator; must differ from requestedBy."},"kmsKeyId":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:+/=-]{0,254}$","description":"KMS key id whose rows are re-wrapped."},"newRecipientFpr":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:+/=-]{0,254}$","description":"New recovery-recipient fingerprint."},"batchSize":{"type":"integer","minimum":1,"maximum":10000,"description":"Rows per resumable batch (worker default when omitted)."}},"required":["incidentRef","requestedBy","approvedBy","kmsKeyId","newRecipientFpr"],"additionalProperties":false,"description":"Start a recovery-share re-wrap run (ADR-0004 D7)."}}}},"responses":{"202":{"description":"Run queued for a worker.","content":{"application/json":{"schema":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","description":"Server-generated run id (also in the audit event)."},"job":{"type":"string","enum":["master_rewrap","recovery_rewrap","room_rotate"],"description":"Rotation job: re-wrap the KMS master key, the recovery shares, or one room key."},"status":{"type":"string","enum":["queued"],"description":"The run is queued for a worker."}},"required":["runId","job","status"],"description":"Queued key-rotation run."}}}},"400":{"description":"Invalid body (unknown keys, malformed ids or versions).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out, or a fresh second factor is required (STEP_UP_REQUIRED on a stale session).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: the principal lacks the rotation action (non-admins), or the caller is neither of the two named operators.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Four-eyes refused: requestedBy and approvedBy are the same operator.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"No queue is available to run the rotation (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/key-rotation/rooms/{roomId}/rotate":{"post":{"operationId":"startKeyRotationRoomRotate","summary":"Rotate one room key","description":"Queues the retire-then-create rotation of the active room key plus the DEK re-wrap of its blobs (T-260916-9083, SEC-02, ADR-0004 D7). Requires key.rotation.room_rotate (firm admins, step-up) and the four-eyes block. Emits room_key.rotated. Retired versions are never destroyed here (ADR-0014 D3 guard, T-260914-ef47).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"incidentRef":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$","description":"Opaque incident record reference."},"requestedBy":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9._:+-]{0,127}$","description":"Operator who requested the run."},"approvedBy":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9._:+-]{0,127}$","description":"Second operator; must differ from requestedBy."},"batchSize":{"type":"integer","minimum":1,"maximum":10000,"description":"Rows per resumable batch (worker default when omitted)."}},"required":["incidentRef","requestedBy","approvedBy"],"additionalProperties":false,"description":"Rotate one room key and re-wrap its DEKs to the new version (ADR-0004 D7)."}}}},"responses":{"202":{"description":"Run queued for a worker.","content":{"application/json":{"schema":{"type":"object","properties":{"runId":{"type":"string","format":"uuid","description":"Server-generated run id (also in the audit event)."},"job":{"type":"string","enum":["master_rewrap","recovery_rewrap","room_rotate"],"description":"Rotation job: re-wrap the KMS master key, the recovery shares, or one room key."},"status":{"type":"string","enum":["queued"],"description":"The run is queued for a worker."}},"required":["runId","job","status"],"description":"Queued key-rotation run."}}}},"400":{"description":"Invalid body (unknown keys, malformed ids or versions).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out, or a fresh second factor is required (STEP_UP_REQUIRED on a stale session).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: the principal lacks the rotation action (non-admins), or the caller is neither of the two named operators.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Four-eyes refused: requestedBy and approvedBy are the same operator.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"No queue is available to run the rotation (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/key-rotation/summary":{"get":{"operationId":"getKeyRotationSummary","summary":"Read the tenant key-rotation summary","description":"Reads the tenant-scoped rotation state for the firm-admin overview card (T-261007-f9e3). Requires key.rotation.summary_read (firm admins, step-up). A tenant that never rotated gets the explicit never-rotated state, never a fake date. Refuse reads hide as 404.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"Tenant-scoped rotation summary.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","enum":["never-rotated"],"description":"This tenant never completed a rotation."},"lastRotationAt":{"nullable":true,"description":"No completed rotation, so no date."},"nextRotationAt":{"nullable":true,"description":"No completed rotation, so no due date."},"activeKeys":{"type":"integer","minimum":0,"description":"Active key versions for the firm."}},"required":["status","lastRotationAt","nextRotationAt","activeKeys"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","enum":["rotated"],"description":"At least one rotation completed."},"lastRotationAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"ISO day of the last completed rotation."},"nextRotationAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"ISO day the next rotation is due."},"activeKeys":{"type":"integer","minimum":0,"description":"Active key versions for the firm."}},"required":["status","lastRotationAt","nextRotationAt","activeKeys"],"additionalProperties":false}],"description":"Tenant-scoped key-rotation summary."}}}},"401":{"description":"Signed out, or a fresh second factor is required (STEP_UP_REQUIRED on a stale session).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: the principal lacks the summary action (non-admins).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"The summary reader drifted off-contract (fail closed, never a fake summary).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/firm":{"get":{"operationId":"getFirm","summary":"Read the firm profile","description":"Firm profile (name, KvK number, billing contact) and the role catalogue (T-260914-7f56, ORG-01/ORG-03). Every firm role reads the profile through tenant.profile.read; the settings are a separate endpoint. 404 hides existence (including cross-tenant, PERM-02).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"Firm account and role catalogue.","content":{"application/json":{"schema":{"type":"object","properties":{"profile":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"name":{"type":"string","nullable":true,"description":"Firm name (scrubbed at tenant termination)."},"kvkNumber":{"type":"string","nullable":true,"pattern":"^[0-9]{8}$","description":"KvK number, or null when not set."},"billingContact":{"type":"object","nullable":true,"properties":{"name":{"type":"string","minLength":1,"maxLength":200,"description":"Billing contact name."},"email":{"type":"string","maxLength":320,"format":"email","description":"Billing contact e-mail address."},"reference":{"type":"string","nullable":true,"minLength":1,"maxLength":100,"description":"Purchase-order or reference line, optional."}},"required":["name","email"],"description":"Billing contact, or null when not set."}},"required":["tenantId","name","kvkNumber","billingContact"],"description":"Firm profile."},"roleCatalogue":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["firm_admin","lawyer","legal_assistant","secretary","billing","adviser","back_office","compliance"],"description":"Firm role (ADR-0005 §3)."},"privileged":{"type":"boolean","description":"Granting or revoking needs step-up (ADR-0003 D5)."},"readOnlyContent":{"type":"boolean","description":"Role never writes content (ADR-0005 §3: compliance)."},"profession":{"type":"string","enum":["professional","support"],"description":"Billing profession of this role (BILL-07)."}},"required":["role","privileged","readOnlyContent","profession"],"description":"A role of the firm role catalogue."},"description":"The eight firm roles."},"capabilities":{"type":"array","items":{"type":"string","enum":["wwft_cdd","mortgage_files","litigation_exports","bsn_guardrail","medical_zones","deal_room","legal_practice"],"description":"Switchable office function (SP08): wwft_cdd (Wwft client research), mortgage_files (mortgage deadlines, checklist, Kifid export and the /mortgage overview), litigation_exports (productions, Mijn Rechtspraak bundle), bsn_guardrail (BSN upload guardrail), medical_zones (injury-case zones) or deal_room (Q&A, bidder groups, phased release) or legal_practice (lawyer wording, practice area and counterparty fields and the legal help articles; presentation only, the API keeps accepting the fields so no data is lost). Security, MFA, audit, retention floors, legal holds, rights and step-up are never capabilities."},"maxItems":7,"description":"Enabled office capabilities for navigation gating (SP08)."}},"required":["profile","roleCatalogue","capabilities"],"description":"Firm account, role catalogue and enabled office capabilities."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"patch":{"operationId":"updateFirmProfile","summary":"Update the firm profile","description":"Updates name, KvK number (eight digits) and the billing contact; null clears a value. Firm admins only (tenant.settings.update with step-up). Emits tenant.settings_changed with setting_codes [\"firm_profile\"].","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200,"description":"New firm name."},"kvkNumber":{"type":"string","nullable":true,"pattern":"^[0-9]{8}$","description":"New KvK number, or null to clear it."},"billingContact":{"type":"object","nullable":true,"properties":{"name":{"type":"string","minLength":1,"maxLength":200,"description":"Billing contact name."},"email":{"type":"string","maxLength":320,"format":"email","description":"Billing contact e-mail address."},"reference":{"type":"string","nullable":true,"minLength":1,"maxLength":100,"description":"Purchase-order or reference line, optional."}},"required":["name","email"],"description":"New billing contact, or null to clear it."}},"description":"Update the firm profile."}}}},"responses":{"200":{"description":"Stored firm account and role catalogue.","content":{"application/json":{"schema":{"type":"object","properties":{"profile":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"name":{"type":"string","nullable":true,"description":"Firm name (scrubbed at tenant termination)."},"kvkNumber":{"type":"string","nullable":true,"pattern":"^[0-9]{8}$","description":"KvK number, or null when not set."},"billingContact":{"type":"object","nullable":true,"properties":{"name":{"type":"string","minLength":1,"maxLength":200,"description":"Billing contact name."},"email":{"type":"string","maxLength":320,"format":"email","description":"Billing contact e-mail address."},"reference":{"type":"string","nullable":true,"minLength":1,"maxLength":100,"description":"Purchase-order or reference line, optional."}},"required":["name","email"],"description":"Billing contact, or null when not set."}},"required":["tenantId","name","kvkNumber","billingContact"],"description":"Firm profile."},"roleCatalogue":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["firm_admin","lawyer","legal_assistant","secretary","billing","adviser","back_office","compliance"],"description":"Firm role (ADR-0005 §3)."},"privileged":{"type":"boolean","description":"Granting or revoking needs step-up (ADR-0003 D5)."},"readOnlyContent":{"type":"boolean","description":"Role never writes content (ADR-0005 §3: compliance)."},"profession":{"type":"string","enum":["professional","support"],"description":"Billing profession of this role (BILL-07)."}},"required":["role","privileged","readOnlyContent","profession"],"description":"A role of the firm role catalogue."},"description":"The eight firm roles."},"capabilities":{"type":"array","items":{"type":"string","enum":["wwft_cdd","mortgage_files","litigation_exports","bsn_guardrail","medical_zones","deal_room","legal_practice"],"description":"Switchable office function (SP08): wwft_cdd (Wwft client research), mortgage_files (mortgage deadlines, checklist, Kifid export and the /mortgage overview), litigation_exports (productions, Mijn Rechtspraak bundle), bsn_guardrail (BSN upload guardrail), medical_zones (injury-case zones) or deal_room (Q&A, bidder groups, phased release) or legal_practice (lawyer wording, practice area and counterparty fields and the legal help articles; presentation only, the API keeps accepting the fields so no data is lost). Security, MFA, audit, retention floors, legal holds, rights and step-up are never capabilities."},"maxItems":7,"description":"Enabled office capabilities for navigation gating (SP08)."}},"required":["profile","roleCatalogue","capabilities"],"description":"Firm account, role catalogue and enabled office capabilities."}}}},"400":{"description":"Invalid profile field (KvK format, empty name).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (non-admins) or step-up required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/firm/settings":{"get":{"operationId":"getFirmSettings","summary":"Read the firm-wide settings","description":"MFA policy (ADR-0003 D14), default watermark, allowed room types, default retention schedule reference and the session lifetimes of ADR-0003 D3 (T-260914-7f56, ORG-10). Firm admins only, through the read action tenant.settings.read (T-261015-d6c2 answers HRQ question 8 of T-260914-7f56: the read no longer reuses the step-up write action, so the admin shell sentence works for the whole session; writes keep tenant.settings.update with step-up); 404 hides existence.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"Firm-wide settings.","content":{"application/json":{"schema":{"type":"object","properties":{"mfaPolicy":{"type":"string","enum":["passkey_or_totp","passkey_only","not_required"],"description":"Firm MFA policy (ADR-0003 D5, D14): any MFA (default), passkeys only, or no second factor required."},"watermarkDefault":{"type":"boolean","description":"Default watermark for new rooms (PERM-12)."},"allowedRoomTypes":{"type":"array","items":{"type":"string","enum":["client_portal","litigation","mortgage_advice"],"description":"Room type the firm allows."},"minItems":1,"description":"Room types the firm allows; at least one."},"retentionScheduleRef":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,63}$","description":"Default retention schedule code, or null when the firm has no default."},"userSessionIdleTimeoutSeconds":{"type":"integer","minimum":900,"maximum":3600,"description":"User session idle timeout in seconds (15-60 minutes)."},"userSessionAbsoluteTimeoutSeconds":{"type":"integer","minimum":14400,"maximum":43200,"description":"User session absolute timeout in seconds (4-12 hours)."},"guestSessionIdleTimeoutSeconds":{"type":"integer","minimum":300,"maximum":1800,"description":"Guest session idle timeout in seconds (at most the 30-minute default)."},"guestSessionAbsoluteTimeoutSeconds":{"type":"integer","minimum":1800,"maximum":28800,"description":"Guest session absolute timeout in seconds (at most the 8-hour default)."},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Firm vertical (ADR-0030): mortgage switches the web to the mortgage adviser shell."},"bsnGuardrail":{"type":"boolean","description":"BSN guardrail on uploads for a non-mortgage firm (always on for mortgage firms)."},"guestDownloadMode":{"type":"string","enum":["original","watermarked_pdf"],"description":"What a guest with the download level receives (PERM-12, ADR-0037): the original file, or only a watermarked PDF."},"trashRetentionDays":{"type":"integer","minimum":30,"maximum":365,"description":"Days a trashed document or folder stays restorable before the worker deletes it definitively (ADR-0039; 30-365, default 30)."},"ipAllowListFirmUsers":{"type":"boolean","description":"Whether a room IP allow-list (PERM-11, ADR-0050) also applies to the firm’s own users; default: external groups only."},"purgeFourEyes":{"type":"boolean","description":"Whether a definitive deletion from the trash needs a second room manager (four eyes, ADR-0039)."},"smsDailyBudget":{"type":"integer","minimum":1,"maximum":10000,"description":"Guest SMS codes the firm's guests may be sent per 24 hours (ADR-0042; 1-10000, default 200). When used up, the SMS step answers 429 SMS_BUDGET_EXCEEDED."},"requestReminderDays":{"type":"array","items":{"type":"integer","minimum":1,"maximum":365},"maxItems":10,"description":"Days after sending on which an open request reminds its recipient (ADR-0053)."},"requestReminderRepeatDays":{"type":"integer","minimum":0,"maximum":90,"description":"Repeat interval in days after the last scheduled reminder; 0 switches repeating off."},"complianceScopeRoomTypes":{"type":"array","nullable":true,"items":{"type":"string","enum":["client_portal","litigation","mortgage_advice"],"description":"Room type the firm allows."},"description":"Compliance scope narrowing (T-260914-b3df): room types the compliance role may view, or null for the tenant-wide default. Absent on older servers."},"complianceScopeRoomIds":{"type":"array","nullable":true,"items":{"type":"string","format":"uuid"},"maxItems":500,"description":"Compliance scope narrowing (T-260914-b3df): explicit room ids the compliance role may view, or null for the tenant-wide default. Absent on older servers."},"securityContact":{"type":"object","nullable":true,"properties":{"role":{"type":"string","minLength":1,"maxLength":200,"description":"Function or title of the security contact (for example the security officer)."},"email":{"type":"string","maxLength":320,"format":"email","description":"E-mail address for security reports to this office."},"phone":{"type":"string","pattern":"^\\+[1-9][0-9]{7,14}$","description":"Callback phone number in E.164, for example +31201234567."}},"required":["role","email","phone"],"description":"Tenant-recorded security contact (T-260914-bba1): the contact this office recorded, or null when it recorded nothing. Absent on older servers. Never a global address."},"memberApiKeys":{"type":"boolean","description":"Whether members may create their own API keys under Mijn koppelingen (default false)."},"memberApiKeyScopes":{"type":"array","items":{"type":"string","enum":["rooms.read","documents.read","documents.upload","flows.read","exhibits.read","messaging.read","qa.read","team.read","office.read"],"description":"One scope a personal key may hold (ADR-0067 D4: read-only plus documents.upload)."},"maxItems":9,"description":"Whitelist of scopes a personal key may hold (default empty). Only read scopes and documents.upload can ever be listed."},"memberApiKeyMaxDays":{"type":"integer","minimum":1,"maximum":365,"description":"Lifetime ceiling of a personal key in days (1-365, default 90)."},"memberApiKeyRoomScopeRequired":{"type":"boolean","description":"Whether a personal key must name the data rooms it is limited to (default true)."},"memberApiKeyMax":{"type":"integer","minimum":1,"maximum":20,"description":"Active personal keys per member (1-20, default 3)."},"memberMcp":{"type":"boolean","description":"Whether a personal key may use the MCP endpoint /mcp/v1 (default false), independent of its scopes."},"updatedAt":{"type":"string","format":"date-time","description":"Last change timestamp."}},"required":["mfaPolicy","watermarkDefault","allowedRoomTypes","retentionScheduleRef","userSessionIdleTimeoutSeconds","userSessionAbsoluteTimeoutSeconds","guestSessionIdleTimeoutSeconds","guestSessionAbsoluteTimeoutSeconds","vertical","bsnGuardrail","guestDownloadMode","trashRetentionDays","ipAllowListFirmUsers","purgeFourEyes","smsDailyBudget","updatedAt"],"description":"Firm-wide settings."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (non-admins).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"patch":{"operationId":"updateFirmSettings","summary":"Update the firm-wide settings","description":"Updates the MFA policy, default watermark, allowed room types, default retention schedule reference and the session lifetimes; the API refuses a user window outside 15-60 minutes / 4-12 hours, a guest window longer than the 30-minute / 8-hour default, an absolute lifetime not strictly longer than the idle lifetime, and a room-type list with duplicates (ADR-0003 D3, ORG-10; the lifetime bounds and the non-empty room-type subset mirror the database CHECKs of migration 0024, duplicates are rejected by the contract schema). Firm admins only with step-up. Emits tenant.settings_changed with setting_codes [\"firm_settings\"]. The MFA policy `not_required` (ADR-0003 D14) switches the second factor off for the users of the firm; switching to it first updates the identity provider, and answers 503 SOURCE_UNAVAILABLE without storing anything when that fails.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"mfaPolicy":{"type":"string","enum":["passkey_or_totp","passkey_only","not_required"],"description":"Firm MFA policy (ADR-0003 D5, D14): any MFA (default), passkeys only, or no second factor required."},"watermarkDefault":{"type":"boolean"},"allowedRoomTypes":{"type":"array","items":{"type":"string","enum":["client_portal","litigation","mortgage_advice"],"description":"Room type the firm allows."},"minItems":1},"retentionScheduleRef":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,63}$","description":"New default retention schedule code, or null to clear it."},"userSessionIdleTimeoutSeconds":{"type":"integer","minimum":900,"maximum":3600},"userSessionAbsoluteTimeoutSeconds":{"type":"integer","minimum":14400,"maximum":43200},"guestSessionIdleTimeoutSeconds":{"type":"integer","minimum":300,"maximum":1800},"guestSessionAbsoluteTimeoutSeconds":{"type":"integer","minimum":1800,"maximum":28800},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Firm vertical: legal (law firm) or mortgage (mortgage adviser)."},"bsnGuardrail":{"type":"boolean"},"guestDownloadMode":{"type":"string","enum":["original","watermarked_pdf"]},"trashRetentionDays":{"type":"integer","minimum":30,"maximum":365},"purgeFourEyes":{"type":"boolean"},"ipAllowListFirmUsers":{"type":"boolean"},"smsDailyBudget":{"type":"integer","minimum":1,"maximum":10000},"requestReminderDays":{"type":"array","items":{"type":"integer","minimum":1,"maximum":365},"maxItems":10,"description":"Days after sending on which an open request reminds its recipient (ADR-0053)."},"requestReminderRepeatDays":{"type":"integer","minimum":0,"maximum":90,"description":"Repeat interval in days after the last scheduled reminder; 0 switches repeating off."},"complianceScopeRoomTypes":{"type":"array","nullable":true,"items":{"type":"string","enum":["client_portal","litigation","mortgage_advice"],"description":"Room type the firm allows."},"description":"New compliance scope room types (T-260914-b3df), or null to clear back to the tenant-wide default."},"complianceScopeRoomIds":{"type":"array","nullable":true,"items":{"type":"string","format":"uuid"},"maxItems":500,"description":"New compliance scope room ids (T-260914-b3df), or null to clear back to the tenant-wide default."},"securityContact":{"type":"object","nullable":true,"properties":{"role":{"type":"string","minLength":1,"maxLength":200,"description":"Function or title of the security contact (for example the security officer)."},"email":{"type":"string","maxLength":320,"format":"email","description":"E-mail address for security reports to this office."},"phone":{"type":"string","pattern":"^\\+[1-9][0-9]{7,14}$","description":"Callback phone number in E.164, for example +31201234567."}},"required":["role","email","phone"],"description":"New tenant-recorded security contact (T-260914-bba1), or null to clear it back to \"not configured\"."},"memberApiKeys":{"type":"boolean","description":"Whether members may create their own API keys under Mijn koppelingen (default false)."},"memberApiKeyScopes":{"type":"array","items":{"type":"string","enum":["rooms.read","documents.read","documents.upload","flows.read","exhibits.read","messaging.read","qa.read","team.read","office.read"],"description":"One scope a personal key may hold (ADR-0067 D4: read-only plus documents.upload)."},"maxItems":9,"description":"Whitelist of scopes a personal key may hold (default empty). Only read scopes and documents.upload can ever be listed."},"memberApiKeyMaxDays":{"type":"integer","minimum":1,"maximum":365,"description":"Lifetime ceiling of a personal key in days (1-365, default 90)."},"memberApiKeyRoomScopeRequired":{"type":"boolean","description":"Whether a personal key must name the data rooms it is limited to (default true)."},"memberApiKeyMax":{"type":"integer","minimum":1,"maximum":20,"description":"Active personal keys per member (1-20, default 3)."},"memberMcp":{"type":"boolean","description":"Whether a personal key may use the MCP endpoint /mcp/v1 (default false), independent of its scopes."}},"description":"Update firm settings."}}}},"responses":{"200":{"description":"Stored firm-wide settings.","content":{"application/json":{"schema":{"type":"object","properties":{"mfaPolicy":{"type":"string","enum":["passkey_or_totp","passkey_only","not_required"],"description":"Firm MFA policy (ADR-0003 D5, D14): any MFA (default), passkeys only, or no second factor required."},"watermarkDefault":{"type":"boolean","description":"Default watermark for new rooms (PERM-12)."},"allowedRoomTypes":{"type":"array","items":{"type":"string","enum":["client_portal","litigation","mortgage_advice"],"description":"Room type the firm allows."},"minItems":1,"description":"Room types the firm allows; at least one."},"retentionScheduleRef":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,63}$","description":"Default retention schedule code, or null when the firm has no default."},"userSessionIdleTimeoutSeconds":{"type":"integer","minimum":900,"maximum":3600,"description":"User session idle timeout in seconds (15-60 minutes)."},"userSessionAbsoluteTimeoutSeconds":{"type":"integer","minimum":14400,"maximum":43200,"description":"User session absolute timeout in seconds (4-12 hours)."},"guestSessionIdleTimeoutSeconds":{"type":"integer","minimum":300,"maximum":1800,"description":"Guest session idle timeout in seconds (at most the 30-minute default)."},"guestSessionAbsoluteTimeoutSeconds":{"type":"integer","minimum":1800,"maximum":28800,"description":"Guest session absolute timeout in seconds (at most the 8-hour default)."},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Firm vertical (ADR-0030): mortgage switches the web to the mortgage adviser shell."},"bsnGuardrail":{"type":"boolean","description":"BSN guardrail on uploads for a non-mortgage firm (always on for mortgage firms)."},"guestDownloadMode":{"type":"string","enum":["original","watermarked_pdf"],"description":"What a guest with the download level receives (PERM-12, ADR-0037): the original file, or only a watermarked PDF."},"trashRetentionDays":{"type":"integer","minimum":30,"maximum":365,"description":"Days a trashed document or folder stays restorable before the worker deletes it definitively (ADR-0039; 30-365, default 30)."},"ipAllowListFirmUsers":{"type":"boolean","description":"Whether a room IP allow-list (PERM-11, ADR-0050) also applies to the firm’s own users; default: external groups only."},"purgeFourEyes":{"type":"boolean","description":"Whether a definitive deletion from the trash needs a second room manager (four eyes, ADR-0039)."},"smsDailyBudget":{"type":"integer","minimum":1,"maximum":10000,"description":"Guest SMS codes the firm's guests may be sent per 24 hours (ADR-0042; 1-10000, default 200). When used up, the SMS step answers 429 SMS_BUDGET_EXCEEDED."},"requestReminderDays":{"type":"array","items":{"type":"integer","minimum":1,"maximum":365},"maxItems":10,"description":"Days after sending on which an open request reminds its recipient (ADR-0053)."},"requestReminderRepeatDays":{"type":"integer","minimum":0,"maximum":90,"description":"Repeat interval in days after the last scheduled reminder; 0 switches repeating off."},"complianceScopeRoomTypes":{"type":"array","nullable":true,"items":{"type":"string","enum":["client_portal","litigation","mortgage_advice"],"description":"Room type the firm allows."},"description":"Compliance scope narrowing (T-260914-b3df): room types the compliance role may view, or null for the tenant-wide default. Absent on older servers."},"complianceScopeRoomIds":{"type":"array","nullable":true,"items":{"type":"string","format":"uuid"},"maxItems":500,"description":"Compliance scope narrowing (T-260914-b3df): explicit room ids the compliance role may view, or null for the tenant-wide default. Absent on older servers."},"securityContact":{"type":"object","nullable":true,"properties":{"role":{"type":"string","minLength":1,"maxLength":200,"description":"Function or title of the security contact (for example the security officer)."},"email":{"type":"string","maxLength":320,"format":"email","description":"E-mail address for security reports to this office."},"phone":{"type":"string","pattern":"^\\+[1-9][0-9]{7,14}$","description":"Callback phone number in E.164, for example +31201234567."}},"required":["role","email","phone"],"description":"Tenant-recorded security contact (T-260914-bba1): the contact this office recorded, or null when it recorded nothing. Absent on older servers. Never a global address."},"memberApiKeys":{"type":"boolean","description":"Whether members may create their own API keys under Mijn koppelingen (default false)."},"memberApiKeyScopes":{"type":"array","items":{"type":"string","enum":["rooms.read","documents.read","documents.upload","flows.read","exhibits.read","messaging.read","qa.read","team.read","office.read"],"description":"One scope a personal key may hold (ADR-0067 D4: read-only plus documents.upload)."},"maxItems":9,"description":"Whitelist of scopes a personal key may hold (default empty). Only read scopes and documents.upload can ever be listed."},"memberApiKeyMaxDays":{"type":"integer","minimum":1,"maximum":365,"description":"Lifetime ceiling of a personal key in days (1-365, default 90)."},"memberApiKeyRoomScopeRequired":{"type":"boolean","description":"Whether a personal key must name the data rooms it is limited to (default true)."},"memberApiKeyMax":{"type":"integer","minimum":1,"maximum":20,"description":"Active personal keys per member (1-20, default 3)."},"memberMcp":{"type":"boolean","description":"Whether a personal key may use the MCP endpoint /mcp/v1 (default false), independent of its scopes."},"updatedAt":{"type":"string","format":"date-time","description":"Last change timestamp."}},"required":["mfaPolicy","watermarkDefault","allowedRoomTypes","retentionScheduleRef","userSessionIdleTimeoutSeconds","userSessionAbsoluteTimeoutSeconds","guestSessionIdleTimeoutSeconds","guestSessionAbsoluteTimeoutSeconds","vertical","bsnGuardrail","guestDownloadMode","trashRetentionDays","ipAllowListFirmUsers","purgeFourEyes","smsDailyBudget","updatedAt"],"description":"Firm-wide settings."}}}},"400":{"description":"Invalid setting (policy, empty room-type list, lifetime bounds).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (non-admins) or step-up required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"SOURCE_UNAVAILABLE: switching the MFA policy to not_required could not update the identity provider; nothing was stored (ADR-0003 D14).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/audit-events":{"get":{"operationId":"listRoomAuditEvents","summary":"Query room audit events","description":"Queries room audit events with filters and keyset pagination (AUD-03, T-260914-97dc). Requires audit.read_room (firm_admin/compliance with room manage). Rows carry ids and codes only; display names and titles come in labels, resolved at read time under the access of the reader (ADR-0006 D10).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Only events of this actor."},"required":false,"description":"Only events of this actor.","name":"principalId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Only events for this document/object."},"required":false,"description":"Only events for this document/object.","name":"documentId","in":"query"},{"schema":{"type":"string","maxLength":80,"pattern":"^([a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+|[a-z][a-z0-9_]*\\.)$","description":"Only events of this catalogue type (e.g. document.downloaded), or of one resource when the value ends in a dot (e.g. permission.)."},"required":false,"description":"Only events of this catalogue type (e.g. document.downloaded), or of one resource when the value ends in a dot (e.g. permission.).","name":"eventType","in":"query"},{"schema":{"type":"string","pattern":"^[A-Z][A-Z2-7]{7}$","description":"Only events carrying this watermark forensic id (details.watermark_id, T-260914-a10f): the 8-char id drawn in a downloaded PDF or viewed page, for looking up the matching audit event. Query surface only: report generation omits it, so a stored report is never silently scoped to one id."},"required":false,"description":"Only events carrying this watermark forensic id (details.watermark_id, T-260914-a10f): the 8-char id drawn in a downloaded PDF or viewed page, for looking up the matching audit event. Query surface only: report generation omits it, so a stored report is never silently scoped to one id.","name":"watermarkId","in":"query"},{"schema":{"type":"string","format":"date-time","description":"Inclusive lower bound (ISO-8601)."},"required":false,"description":"Inclusive lower bound (ISO-8601).","name":"from","in":"query"},{"schema":{"type":"string","format":"date-time","description":"Inclusive upper bound (ISO-8601)."},"required":false,"description":"Inclusive upper bound (ISO-8601).","name":"to","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Max rows (1-1000)."},"required":false,"description":"Max rows (1-1000).","name":"limit","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z_[0-9a-f-]{36}$","description":"Keyset cursor from a previous page (nextCursor); events query only."},"required":false,"description":"Keyset cursor from a previous page (nextCursor); events query only.","name":"cursor","in":"query"}],"responses":{"200":{"description":"Matching events with a verification summary.","content":{"application/json":{"schema":{"type":"object","properties":{"events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event id (the public reference, ADR-0006 D2)."},"seq":{"type":"integer","nullable":true,"description":"Chain sequence number; null while the event awaits sealing (seconds)."},"occurredAt":{"type":"string","format":"date-time","description":"When the event happened (ISO-8601)."},"recordedAt":{"type":"string","format":"date-time","description":"When the database recorded it (ISO-8601)."},"type":{"type":"string","description":"Catalogue event type (e.g. document.downloaded)."},"actorId":{"type":"string","description":"Acting principal id (empty for system and anonymous events)."},"actorKind":{"type":"string","enum":["user","guest","support","service","system","anonymous"],"description":"Kind of actor (ADR-0006 D2)."},"roomId":{"type":"string","nullable":true,"description":"Room id, null outside a room."},"documentId":{"type":"string","nullable":true,"description":"Document/object id, null without one."},"objectType":{"type":"string","nullable":true,"description":"Primary object type code."},"objectId":{"type":"string","nullable":true,"description":"Primary object id."},"details":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"nullable":true},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}]},"description":"Catalogue details: ids, codes and counts only (ADR-0006 D3)."},"ip":{"type":"string","nullable":true,"description":"Client address as seen by the API."},"device":{"type":"string","nullable":true,"description":"Normalised <browser>/<os> label."},"eventDigest":{"type":"string","nullable":true,"description":"SHA-256 event digest (hex), once sealed."},"hash":{"type":"string","nullable":true,"description":"Chain hash after this event (hex), once sealed."}},"required":["seq","occurredAt","type","actorId","roomId","documentId"],"description":"One audit event (ids and codes; names in labels)."},"description":"Matching events: newest first on the database path, chain order in memory."},"verification":{"type":"object","properties":{"status":{"type":"string","enum":["verified","failed"],"description":"Chain verification outcome."},"checkedAt":{"type":"string","format":"date-time","description":"When the check ran (ISO-8601)."},"eventCount":{"type":"integer","description":"Events covered by the check."},"firstSeq":{"type":"integer","nullable":true,"description":"First sequence covered, null when empty."},"lastSeq":{"type":"integer","nullable":true,"description":"Last sequence covered, null when empty."},"headSeq":{"type":"integer","nullable":true,"description":"Verified chain head sequence."},"headHash":{"type":"string","nullable":true,"description":"Verified chain head hash (hex)."},"failureCode":{"type":"string","nullable":true,"description":"ADR-0006 D8 failure code when failed."},"failedSeq":{"type":"integer","nullable":true,"description":"First failing sequence when failed."}},"required":["status","checkedAt","eventCount","firstSeq","lastSeq"],"description":"Verification summary attached to every report."},"labels":{"type":"object","properties":{"principals":{"type":"object","additionalProperties":{"type":"string"},"description":"Principal id -> display name."},"documents":{"type":"object","additionalProperties":{"type":"string"},"description":"Document id -> title."},"nodes":{"type":"object","additionalProperties":{"type":"string"},"description":"Index node id -> title."},"groups":{"type":"object","additionalProperties":{"type":"string"},"description":"Group id -> name."},"rooms":{"type":"object","additionalProperties":{"type":"string"},"description":"Room id -> name."}},"required":["principals","documents","nodes","groups","rooms"],"description":"Display names resolved at read time (never stored in audit rows)."},"nextCursor":{"type":"string","nullable":true,"description":"Cursor for the next (older) page."}},"required":["events","verification"],"description":"Room audit events with a verification summary."}}}},"400":{"description":"Invalid filter.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant/room, or no access (PERM-02: reads as missing).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/audit-reports":{"post":{"operationId":"generateRoomAuditReport","summary":"Generate a stored audit report","description":"Generates a stored CSV report with a SHA-256 integrity proof (AUD-03, T-260914-97dc). Requires audit.read_room. Emits audit.report_generated. The CSV downloads separately.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"principalId":{"type":"string","format":"uuid","description":"Only events of this actor."},"documentId":{"type":"string","format":"uuid","description":"Only events for this document/object."},"eventType":{"type":"string","maxLength":80,"pattern":"^([a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+|[a-z][a-z0-9_]*\\.)$","description":"Only events of this catalogue type (e.g. document.downloaded), or of one resource when the value ends in a dot (e.g. permission.)."},"from":{"type":"string","format":"date-time","description":"Inclusive lower bound (ISO-8601)."},"to":{"type":"string","format":"date-time","description":"Inclusive upper bound (ISO-8601)."},"cursor":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z_[0-9a-f-]{36}$","description":"Keyset cursor from a previous page (nextCursor); events query only."},"limit":{"type":"integer","minimum":1,"maximum":1000,"default":1000,"description":"Max rows (1-1000)."}},"description":"Generate an audit report with these filters."}}}},"responses":{"201":{"description":"Stored report metadata (CSV downloads separately).","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Stored report id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"roomId":{"type":"string","format":"uuid","description":"Reported room."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."},"expiresAt":{"type":"string","format":"date-time","description":"Download expiry (+7 days)."},"sha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"SHA-256 hex of the exact CSV bytes."},"rowCount":{"type":"integer","description":"Rows in the stored CSV."},"verification":{"type":"object","properties":{"status":{"type":"string","enum":["verified","failed"],"description":"Chain verification outcome."},"checkedAt":{"type":"string","format":"date-time","description":"When the check ran (ISO-8601)."},"eventCount":{"type":"integer","description":"Events covered by the check."},"firstSeq":{"type":"integer","nullable":true,"description":"First sequence covered, null when empty."},"lastSeq":{"type":"integer","nullable":true,"description":"Last sequence covered, null when empty."},"headSeq":{"type":"integer","nullable":true,"description":"Verified chain head sequence."},"headHash":{"type":"string","nullable":true,"description":"Verified chain head hash (hex)."},"failureCode":{"type":"string","nullable":true,"description":"ADR-0006 D8 failure code when failed."},"failedSeq":{"type":"integer","nullable":true,"description":"First failing sequence when failed."}},"required":["status","checkedAt","eventCount","firstSeq","lastSeq"],"description":"Verification summary attached to every report."}},"required":["id","tenantId","roomId","createdAt","expiresAt","sha256","rowCount","verification"],"description":"Generated audit report metadata (CSV downloads separately)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant/room, or no access (PERM-02: reads as missing).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"AUDIT_UNAVAILABLE: the audit event could not be written; nothing was served (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/audit-reports/pdf":{"post":{"operationId":"generateRoomAuditReportPdf","summary":"Generate a stored audit-report PDF","description":"Generates a stored PDF report through the audit.report-pdf worker builder (AUD-03, T-260915-bd1b). Requires audit.read_room. Emits audit.report_generated. The PDF downloads separately; IDs only in the bytes and the metadata.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","enum":["nl","en"],"default":"en","description":"PDF title/period language."},"required":false,"description":"PDF title/period language.","name":"locale","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"principalId":{"type":"string","format":"uuid","description":"Only events of this actor."},"documentId":{"type":"string","format":"uuid","description":"Only events for this document/object."},"eventType":{"type":"string","maxLength":80,"pattern":"^([a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+|[a-z][a-z0-9_]*\\.)$","description":"Only events of this catalogue type (e.g. document.downloaded), or of one resource when the value ends in a dot (e.g. permission.)."},"from":{"type":"string","format":"date-time","description":"Inclusive lower bound (ISO-8601)."},"to":{"type":"string","format":"date-time","description":"Inclusive upper bound (ISO-8601)."},"cursor":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z_[0-9a-f-]{36}$","description":"Keyset cursor from a previous page (nextCursor); events query only."},"limit":{"type":"integer","minimum":1,"maximum":1000,"default":1000,"description":"Max rows (1-1000)."}},"description":"Generate an audit report with these filters."}}}},"responses":{"201":{"description":"Stored PDF metadata (the PDF downloads separately).","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Stored PDF export id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"roomId":{"type":"string","format":"uuid","description":"Reported room."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."},"expiresAt":{"type":"string","format":"date-time","description":"Download expiry (+7 days)."},"sha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"SHA-256 hex of the exact PDF bytes."},"csvSha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"SHA-256 hex of the underlying CSV bytes the PDF summarises."},"rowCount":{"type":"integer","description":"Rows in the stored report."},"verification":{"type":"object","properties":{"status":{"type":"string","enum":["verified","failed"],"description":"Chain verification outcome."},"checkedAt":{"type":"string","format":"date-time","description":"When the check ran (ISO-8601)."},"eventCount":{"type":"integer","description":"Events covered by the check."},"firstSeq":{"type":"integer","nullable":true,"description":"First sequence covered, null when empty."},"lastSeq":{"type":"integer","nullable":true,"description":"Last sequence covered, null when empty."},"headSeq":{"type":"integer","nullable":true,"description":"Verified chain head sequence."},"headHash":{"type":"string","nullable":true,"description":"Verified chain head hash (hex)."},"failureCode":{"type":"string","nullable":true,"description":"ADR-0006 D8 failure code when failed."},"failedSeq":{"type":"integer","nullable":true,"description":"First failing sequence when failed."}},"required":["status","checkedAt","eventCount","firstSeq","lastSeq"],"description":"Verification summary attached to every report."}},"required":["id","tenantId","roomId","createdAt","expiresAt","sha256","csvSha256","rowCount","verification"],"description":"Generated audit-report PDF metadata (PDF downloads separately)."}}}},"400":{"description":"Invalid request body or query.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant/room, or no access (PERM-02: reads as missing).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"AUDIT_UNAVAILABLE: the audit event could not be written; nothing was served (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/audit-reports/{reportId}/download.pdf":{"get":{"operationId":"downloadAuditReportPdf","summary":"Download an audit-report PDF","description":"Downloads the stored PDF (AUD-03, T-260915-bd1b). Requires audit.export.download (firm_admin/compliance with step-up). The x-ddr-report-sha256 header carries the SHA-256 of the exact bytes. Unknown or expired (>7 days) ids answer 404.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Stored audit report id."},"required":true,"description":"Stored audit report id.","name":"reportId","in":"path"}],"responses":{"200":{"description":"PDF export with the x-ddr-report-sha256 integrity header.","content":{"application/pdf":{"schema":{"type":"string","description":"Audit-report PDF bytes."}}}},"400":{"description":"Invalid request.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (audit.export.download requires firm_admin/compliance with step-up).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown or expired report, or no access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"AUDIT_UNAVAILABLE: the audit event could not be written; nothing was served (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/firm/members":{"get":{"operationId":"listFirmMembers","summary":"List firm users with their roles","description":"Firm users (kind `user`; guests are never firm members) with display name, status and active role grants (T-260914-7f56, ORG-03, PERM-14). Optional `search` narrows server-side on display name and sign-in address (trimmed, max 100 chars; T-261007-44c5). Firm admins and compliance through user.read (ADR-0005 §3); 404 hides existence.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page size, 1-100 (default 50)."},"required":false,"description":"Page size, 1-100 (default 50).","name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"description":"Rows to skip (default 0)."},"required":false,"description":"Rows to skip (default 0).","name":"offset","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":100,"description":"Substring match over display name or sign-in address."},"required":false,"description":"Substring match over display name or sign-in address.","name":"search","in":"query"}],"responses":{"200":{"description":"Firm members with their active roles.","content":{"application/json":{"schema":{"type":"object","properties":{"members":{"type":"array","items":{"type":"object","properties":{"principalId":{"type":"string","format":"uuid","description":"Principal id."},"displayName":{"type":"string","nullable":true,"description":"Display name from the profile, or null."},"status":{"type":"string","enum":["active","blocked","deactivated"],"description":"Principal status (ADR-0003 D3a: deactivated is terminal)."},"profession":{"type":"string","enum":["professional","support"],"description":"Derived billing profession (BILL-07): professional when the user holds any professional role."},"roles":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["firm_admin","lawyer","legal_assistant","secretary","billing","adviser","back_office","compliance"],"description":"Firm role (ADR-0005 §3)."},"privileged":{"type":"boolean","description":"Granting or revoking needed step-up."},"profession":{"type":"string","enum":["professional","support"],"description":"Billing profession of this grant (BILL-07)."},"grantedAt":{"type":"string","format":"date-time","description":"Grant timestamp."},"grantedBy":{"type":"string","nullable":true,"format":"uuid","description":"Granting principal, null for the bootstrap grant."}},"required":["role","privileged","profession","grantedAt","grantedBy"],"description":"An active firm role grant."},"description":"Active role grants, catalogue order."},"email":{"type":"string","nullable":true,"maxLength":254,"format":"email","description":"Sign-in address of the Keycloak identity (ADR-0029), read for the firm admin only; null when unknown. Never logged."},"lastSignInAt":{"type":"string","nullable":true,"format":"date-time","description":"Last sign-in into this firm (ADR-0003 D3a: activity in this tenant only), or null."}},"required":["principalId","displayName","status","profession","roles","email","lastSignInAt"],"description":"A firm user with its roles."},"description":"Firm users, display name order."},"total":{"type":"integer","minimum":0,"description":"Members matching the filters before paging; absent on older servers."}},"required":["members"],"description":"Firm members response."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/firm/members/{principalId}/roles":{"put":{"operationId":"updateFirmMemberRoles","summary":"Replace a member's firm roles","description":"Replaces the complete set of active role grants of one firm user: gone roles are revoked and new roles granted as history rows, never rewritten (ADR-0012 D10). Granting or revoking `firm_admin` or `compliance` needs step-up (ADR-0003 D5) and is checked against the privileged catalogue action; removing the last active firm_admin is refused with 409 LAST_FIRM_ADMIN (PERM-14). Firm admins only (user.role.update). Emits one principal.role_changed per changed role.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the member."},"required":true,"description":"Tenant that owns the member.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Member principal id."},"required":true,"description":"Member principal id.","name":"principalId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"string","enum":["firm_admin","lawyer","legal_assistant","secretary","billing","adviser","back_office","compliance"],"description":"Firm role (ADR-0005 §3)."},"maxItems":8,"description":"The member's complete set of active roles; empty removes all roles."}},"required":["roles"],"description":"Replace a member's active firm roles."}}}},"responses":{"200":{"description":"The member with its new active roles.","content":{"application/json":{"schema":{"type":"object","properties":{"member":{"type":"object","properties":{"principalId":{"type":"string","format":"uuid","description":"Principal id."},"displayName":{"type":"string","nullable":true,"description":"Display name from the profile, or null."},"status":{"type":"string","enum":["active","blocked","deactivated"],"description":"Principal status (ADR-0003 D3a: deactivated is terminal)."},"profession":{"type":"string","enum":["professional","support"],"description":"Derived billing profession (BILL-07): professional when the user holds any professional role."},"roles":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["firm_admin","lawyer","legal_assistant","secretary","billing","adviser","back_office","compliance"],"description":"Firm role (ADR-0005 §3)."},"privileged":{"type":"boolean","description":"Granting or revoking needed step-up."},"profession":{"type":"string","enum":["professional","support"],"description":"Billing profession of this grant (BILL-07)."},"grantedAt":{"type":"string","format":"date-time","description":"Grant timestamp."},"grantedBy":{"type":"string","nullable":true,"format":"uuid","description":"Granting principal, null for the bootstrap grant."}},"required":["role","privileged","profession","grantedAt","grantedBy"],"description":"An active firm role grant."},"description":"Active role grants, catalogue order."},"email":{"type":"string","nullable":true,"maxLength":254,"format":"email","description":"Sign-in address of the Keycloak identity (ADR-0029), read for the firm admin only; null when unknown. Never logged."},"lastSignInAt":{"type":"string","nullable":true,"format":"date-time","description":"Last sign-in into this firm (ADR-0003 D3a: activity in this tenant only), or null."}},"required":["principalId","displayName","status","profession","roles","email","lastSignInAt"],"description":"A firm user with its roles."}},"required":["member"],"description":"Updated firm member."}}}},"400":{"description":"Invalid role list (unknown or duplicate role).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out, or step-up required for a privileged role (STEP_UP_REQUIRED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Refused: this would remove the last firm_admin (LAST_FIRM_ADMIN, PERM-14).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/firm/members/{principalId}/block":{"post":{"operationId":"blockFirmMember","summary":"Disable a firm user","description":"Blocks one firm user now (PERM-10, ADR-0003 D3a, ADR-0029 D4): the principal becomes `blocked` and this firm's sessions of that user are revoked. When no other firm uses the same sign-in identity, the Keycloak user is also disabled and its sessions ended (an identity_admin_intent row is committed first), so the person cannot sign in at all; otherwise only this firm's access ends and `identityChanged` is false. The caller cannot block itself, and the last active firm_admin cannot be blocked (409 LAST_FIRM_ADMIN). Revoking access never needs step-up (principal.block, firm admins only). Emits principal.blocked.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the member."},"required":true,"description":"Tenant that owns the member.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Member principal id."},"required":true,"description":"Member principal id.","name":"principalId","in":"path"}],"responses":{"200":{"description":"The blocked member.","content":{"application/json":{"schema":{"type":"object","properties":{"member":{"type":"object","properties":{"principalId":{"type":"string","format":"uuid","description":"Principal id."},"displayName":{"type":"string","nullable":true,"description":"Display name from the profile, or null."},"status":{"type":"string","enum":["active","blocked","deactivated"],"description":"Principal status (ADR-0003 D3a: deactivated is terminal)."},"profession":{"type":"string","enum":["professional","support"],"description":"Derived billing profession (BILL-07): professional when the user holds any professional role."},"roles":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["firm_admin","lawyer","legal_assistant","secretary","billing","adviser","back_office","compliance"],"description":"Firm role (ADR-0005 §3)."},"privileged":{"type":"boolean","description":"Granting or revoking needed step-up."},"profession":{"type":"string","enum":["professional","support"],"description":"Billing profession of this grant (BILL-07)."},"grantedAt":{"type":"string","format":"date-time","description":"Grant timestamp."},"grantedBy":{"type":"string","nullable":true,"format":"uuid","description":"Granting principal, null for the bootstrap grant."}},"required":["role","privileged","profession","grantedAt","grantedBy"],"description":"An active firm role grant."},"description":"Active role grants, catalogue order."},"email":{"type":"string","nullable":true,"maxLength":254,"format":"email","description":"Sign-in address of the Keycloak identity (ADR-0029), read for the firm admin only; null when unknown. Never logged."},"lastSignInAt":{"type":"string","nullable":true,"format":"date-time","description":"Last sign-in into this firm (ADR-0003 D3a: activity in this tenant only), or null."}},"required":["principalId","displayName","status","profession","roles","email","lastSignInAt"],"description":"A firm user with its roles."},"identityChanged":{"type":"boolean","description":"True when the Keycloak identity was disabled (block) or enabled again (unblock)."}},"required":["member","identityChanged"],"description":"Firm member after a block or unblock."}}}},"401":{"description":"Signed out, or step-up required (STEP_UP_REQUIRED, unblock only).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, a guest and a deactivated member).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Refused: the caller itself (CONFLICT), the last active firm_admin (LAST_FIRM_ADMIN), or the member is not in the expected state (CONFLICT).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/firm/members/{principalId}/unblock":{"post":{"operationId":"unblockFirmMember","summary":"Enable a disabled firm user","description":"Unblocks one blocked firm user (principal.unblock, firm admins only, step-up, ADR-0003 D5): the principal becomes `active` again. When no other firm uses the sign-in identity and it was disabled, the Keycloak user is enabled again (an identity_admin_intent row is committed first; ADR-0029 D4 amends ADR-0003 D3a for this non-shared case). A deactivated member is never reactivated (404). Emits principal.unblocked.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the member."},"required":true,"description":"Tenant that owns the member.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Member principal id."},"required":true,"description":"Member principal id.","name":"principalId","in":"path"}],"responses":{"200":{"description":"The active member.","content":{"application/json":{"schema":{"type":"object","properties":{"member":{"type":"object","properties":{"principalId":{"type":"string","format":"uuid","description":"Principal id."},"displayName":{"type":"string","nullable":true,"description":"Display name from the profile, or null."},"status":{"type":"string","enum":["active","blocked","deactivated"],"description":"Principal status (ADR-0003 D3a: deactivated is terminal)."},"profession":{"type":"string","enum":["professional","support"],"description":"Derived billing profession (BILL-07): professional when the user holds any professional role."},"roles":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["firm_admin","lawyer","legal_assistant","secretary","billing","adviser","back_office","compliance"],"description":"Firm role (ADR-0005 §3)."},"privileged":{"type":"boolean","description":"Granting or revoking needed step-up."},"profession":{"type":"string","enum":["professional","support"],"description":"Billing profession of this grant (BILL-07)."},"grantedAt":{"type":"string","format":"date-time","description":"Grant timestamp."},"grantedBy":{"type":"string","nullable":true,"format":"uuid","description":"Granting principal, null for the bootstrap grant."}},"required":["role","privileged","profession","grantedAt","grantedBy"],"description":"An active firm role grant."},"description":"Active role grants, catalogue order."},"email":{"type":"string","nullable":true,"maxLength":254,"format":"email","description":"Sign-in address of the Keycloak identity (ADR-0029), read for the firm admin only; null when unknown. Never logged."},"lastSignInAt":{"type":"string","nullable":true,"format":"date-time","description":"Last sign-in into this firm (ADR-0003 D3a: activity in this tenant only), or null."}},"required":["principalId","displayName","status","profession","roles","email","lastSignInAt"],"description":"A firm user with its roles."},"identityChanged":{"type":"boolean","description":"True when the Keycloak identity was disabled (block) or enabled again (unblock)."}},"required":["member","identityChanged"],"description":"Firm member after a block or unblock."}}}},"401":{"description":"Signed out, or step-up required (STEP_UP_REQUIRED, unblock only).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, a guest and a deactivated member).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Refused: the caller itself (CONFLICT), the last active firm_admin (LAST_FIRM_ADMIN), or the member is not in the expected state (CONFLICT).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/index":{"get":{"operationId":"listIndexChildren","summary":"List one folder level of the index tree","description":"Lists the direct children of one folder in index order (UX-L09, DOC-02). Numbers are derived from position over the full tree, so a caller who may not see a node sees a gap (ADR-0005 §5). `numbersVisible` is the effective DOC-04 setting for this caller; when it is false every `indexNumber` is null. The position-addressable flat listing, ancestor chain and visible counts stay in T-260914-0c7b.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Folder whose direct children are listed; omit for the room root."},"required":false,"description":"Folder whose direct children are listed; omit for the room root.","name":"parentId","in":"query"},{"schema":{"type":"string","enum":["folder","document","placeholder"],"description":"Only nodes of this kind; the tree asks for `folder` when it loads a level."},"required":false,"description":"Only nodes of this kind; the tree asks for `folder` when it loads a level.","name":"kind","in":"query"},{"schema":{"type":"string","enum":["index","title"],"description":"Child order; defaults to index (position)."},"required":false,"description":"Child order; defaults to index (position).","name":"sort","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":500,"description":"Page size, 1-500 (default 200)."},"required":false,"description":"Page size, 1-500 (default 200).","name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":200,"description":"Opaque keyset cursor from the previous page; never a client-computed offset."},"required":false,"description":"Opaque keyset cursor from the previous page; never a client-computed offset.","name":"cursor","in":"query"}],"responses":{"200":{"description":"One page of children.","content":{"application/json":{"schema":{"type":"object","properties":{"numbersVisible":{"type":"boolean","description":"Effective DOC-04 setting for the caller; false means index numbers are hidden."},"nodes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Index node id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"roomId":{"type":"string","format":"uuid","description":"Owning room."},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent folder; null at the room root."},"kind":{"type":"string","enum":["folder","document","placeholder"],"description":"Index node kind: folder, document or placeholder (expected document)."},"title":{"type":"string","nullable":true,"description":"Node title (client data)."},"indexNumber":{"type":"string","nullable":true,"maxLength":63,"pattern":"^[1-9]\\d*(\\.[1-9]\\d*)*$","description":"Position-derived number; null when the room hides numbers (DOC-04) or the node is trashed."},"position":{"type":"integer","nullable":true,"minimum":0,"description":"0-based sibling position; null while the node is trashed."},"internalMarked":{"type":"boolean","description":"Internal mark set on this node (ADR-0005 §6)."},"internalOnly":{"type":"boolean","description":"Materialised internal state: this node or an ancestor is marked."},"privileged":{"type":"boolean","description":"Legal privilege tag of a document node (RED-06, ADR-0040); guests never receive a privileged node. Absent means false."},"medicalMarked":{"type":"boolean","description":"Special-category zone mark (\"Medisch\") on this folder (ADR-0056). Absent means false."},"medicalOnly":{"type":"boolean","description":"This node lies in a special-category zone (this folder or an ancestor is marked). Absent means false."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Document row of a placeholder or document node; null for a folder (INT-F08, ADR-0007 D3). A placeholder carries the id of its empty row (`current_version_id` null), inserted with the node (T-260921-d705)."},"note":{"type":"string","nullable":true,"description":"Internal placeholder note (UX-L48); null for external groups."},"versionNo":{"type":"integer","nullable":true,"minimum":1,"description":"Number of the current version of a document node (DOC-06 badge); null or absent until a version is available and for folders and placeholders."},"approvalPending":{"type":"boolean","description":"True on a document uploaded with `upload_with_approval` that still waits for a manager (ADR-0026); only the uploader and managers see such a node. Absent otherwise."},"trashedAt":{"type":"string","nullable":true,"format":"date-time","description":"Set while the node is in the trash; null for live nodes."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."},"updatedAt":{"type":"string","format":"date-time","description":"Last structural change."}},"required":["id","tenantId","roomId","parentId","kind","title","indexNumber","position","internalMarked","internalOnly","documentId","note","trashedAt","createdAt","updatedAt"],"description":"One node of the room index tree (folder, document or placeholder)."},"description":"Children of the requested folder in the requested order."},"nextCursor":{"type":"string","nullable":true,"description":"Opaque cursor for the next page; null on the last page."}},"required":["numbersVisible","nodes","nextCursor"],"description":"One page of index-tree children."}}}},"400":{"description":"Invalid query.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, invisible nodes and without access, ADR-0005 §8).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"post":{"operationId":"createIndexNode","summary":"Create a folder or a placeholder","description":"Creates a folder or a placeholder (expected document) and appends it to the target folder; the numbers of its new siblings are recomputed in the same transaction (DOC-02, UX-L45/L47/L48). A placeholder also gets its empty `document` row (`current_version_id` null, linked back through `document.index_node_id`) in that transaction (INT-F08). Requires `edit` on the target folder (ADR-0005 §5); `internalOnly: true` additionally needs `node.internal.mark` (`manage`, users only) and is refused for guests. Writes `index_node.created` (and `index_node.internal_marked` when marked). Document nodes are created by the upload pipeline, never here.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Target folder; null or omitted creates at the room root."},"kind":{"type":"string","enum":["folder","placeholder"],"description":"Kind of node this API can create; a document node arrives through the upload pipeline."},"title":{"type":"string","minLength":1,"maxLength":255,"description":"Node title (folder name, document name or placeholder title); client data."},"note":{"type":"string","maxLength":2000,"description":"Internal note of a placeholder (UX-L48)."},"internalOnly":{"type":"boolean","description":"Mark the new node internal; requires `node.internal.mark` (manage, users only)."}},"required":["kind","title"],"description":"Create a folder or a placeholder in the index tree."}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Index node id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"roomId":{"type":"string","format":"uuid","description":"Owning room."},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent folder; null at the room root."},"kind":{"type":"string","enum":["folder","document","placeholder"],"description":"Index node kind: folder, document or placeholder (expected document)."},"title":{"type":"string","nullable":true,"description":"Node title (client data)."},"indexNumber":{"type":"string","nullable":true,"maxLength":63,"pattern":"^[1-9]\\d*(\\.[1-9]\\d*)*$","description":"Position-derived number; null when the room hides numbers (DOC-04) or the node is trashed."},"position":{"type":"integer","nullable":true,"minimum":0,"description":"0-based sibling position; null while the node is trashed."},"internalMarked":{"type":"boolean","description":"Internal mark set on this node (ADR-0005 §6)."},"internalOnly":{"type":"boolean","description":"Materialised internal state: this node or an ancestor is marked."},"privileged":{"type":"boolean","description":"Legal privilege tag of a document node (RED-06, ADR-0040); guests never receive a privileged node. Absent means false."},"medicalMarked":{"type":"boolean","description":"Special-category zone mark (\"Medisch\") on this folder (ADR-0056). Absent means false."},"medicalOnly":{"type":"boolean","description":"This node lies in a special-category zone (this folder or an ancestor is marked). Absent means false."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Document row of a placeholder or document node; null for a folder (INT-F08, ADR-0007 D3). A placeholder carries the id of its empty row (`current_version_id` null), inserted with the node (T-260921-d705)."},"note":{"type":"string","nullable":true,"description":"Internal placeholder note (UX-L48); null for external groups."},"versionNo":{"type":"integer","nullable":true,"minimum":1,"description":"Number of the current version of a document node (DOC-06 badge); null or absent until a version is available and for folders and placeholders."},"approvalPending":{"type":"boolean","description":"True on a document uploaded with `upload_with_approval` that still waits for a manager (ADR-0026); only the uploader and managers see such a node. Absent otherwise."},"trashedAt":{"type":"string","nullable":true,"format":"date-time","description":"Set while the node is in the trash; null for live nodes."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."},"updatedAt":{"type":"string","format":"date-time","description":"Last structural change."}},"required":["id","tenantId","roomId","parentId","kind","title","indexNumber","position","internalMarked","internalOnly","documentId","note","trashedAt","createdAt","updatedAt"],"description":"One node of the room index tree (folder, document or placeholder)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `edit`/`manage` on the target node, or a guest attempting an internal mark).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, invisible nodes and without access, ADR-0005 §8).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Room is not active (read-only states answer 409 READ_ONLY, ADR-0005 §8).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/index/import":{"post":{"operationId":"importIndexNodes","summary":"Import a folder and placeholder structure in one transaction","description":"Creates up to 5,000 folders and placeholders under one target folder in one transaction (UX-L44 outline paste, MAT-05 index import, UX-L40 B16). Each node names its parent by a request-local `parentKey`; siblings keep request order and the imported roots are appended after the existing children of the target, numbered by position (DOC-02). Requires `node.create` (`edit`) on the target folder (ADR-0005 §5) and an active room; imported nodes inherit an internal target (sticky, §6) and cannot be marked internal here. Writes one `index_node.created` per imported root node sharing one `batch_id` (node id, target parent id and batch only, like `copyIndexNode`, ADR-0006 D4); titles and notes never reach the audit trail.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Target folder; null or omitted imports at the room root."},"nodes":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":64,"description":"Client reference, unique within the request."},"parentKey":{"type":"string","minLength":1,"maxLength":64,"description":"Key of an earlier folder in this request; omitted = directly under the target."},"kind":{"type":"string","enum":["folder","placeholder"],"description":"Kind of node this API can create; a document node arrives through the upload pipeline."},"title":{"type":"string","minLength":1,"maxLength":255,"description":"Node title (folder name, document name or placeholder title); client data."},"note":{"type":"string","maxLength":2000,"description":"Internal note of a placeholder (UX-L48)."}},"required":["key","kind","title"],"description":"One folder or placeholder of a structure import."},"minItems":1,"maxItems":5000,"description":"Nodes in depth-first or breadth-first order: a parent always precedes its children."},"dryRun":{"type":"boolean","description":"Preview only: return the diff and create nothing."}},"required":["nodes"],"description":"Import a folder and placeholder structure in one transaction."}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"type":"object","properties":{"createdCount":{"type":"integer","minimum":0,"description":"Nodes created; with `dryRun`, rows that would be created (0 when every row already exists). A real import always creates at least one node."},"ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Ids of the created nodes, in request order; empty for a dry run."},"dryRun":{"type":"object","properties":{"created":{"type":"integer","minimum":0,"description":"Rows whose title is not in the target subtree yet."},"updated":{"type":"integer","minimum":0,"description":"Rows an import would change; always 0, an import only creates."},"unchanged":{"type":"integer","minimum":0,"description":"Rows whose title already exists in the target subtree."},"truncated":{"type":"boolean","description":"The existing-title scan hit its node cap, so some existing titles were not compared."}},"required":["created","updated","unchanged","truncated"],"description":"Present when the request asked for a dry run."}},"required":["createdCount","ids"],"description":"Result of a structure import."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `edit`/`manage` on the target node, or a guest attempting an internal mark).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, invisible nodes and without access, ADR-0005 §8).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Room is not active (read-only states answer 409 READ_ONLY, ADR-0005 §8).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/index/import-template":{"get":{"operationId":"getIndexImportTemplate","summary":"Download the index import template as CSV","description":"Returns an empty CSV template with the header `number,title,kind,parent` and two synthetic example rows, as a `text/csv` attachment. The client fills the titles and posts the result to `importIndexNodesCsv`; an `.xlsx` workbook is read in the browser and posted in the same shape. The template carries no room data and no client data, but the route still requires a session and `node.read` on the room root so an unauthenticated caller learns nothing about the room (ADR-0005 A8).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"The template as a CSV attachment.","content":{"text/csv":{"schema":{"type":"string"}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `edit`/`manage` on the target node, or a guest attempting an internal mark).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, invisible nodes and without access, ADR-0005 §8).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/index/import-csv":{"post":{"operationId":"importIndexNodesCsv","summary":"Import a folder and placeholder structure from CSV text","description":"Parses `number,title,kind,parent` CSV text server-side and creates the same structure, under the same conditions, in the same transaction and with the same audit events as the JSON import (MAT-05, UX-L44). A parent row must precede its children and name them by their position number; `kind` is `folder` or `placeholder`. `dryRun: true` returns the same diff as the JSON import and writes nothing. A malformed row (bad header, empty title, unknown kind, unknown or forward parent, or more than 5,000 rows) is 400 as a whole; titles never reach logs or the audit trail (CLAUDE.md rule 1).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Target folder; null or omitted imports at the room root."},"csv":{"type":"string","minLength":1,"maxLength":524288,"description":"Header row `number,title,kind,parent` plus one row per node, in document order."},"dryRun":{"type":"boolean","description":"Preview only: return the diff and create nothing."}},"required":["csv"],"description":"Import a folder and placeholder structure from CSV text."}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"type":"object","properties":{"createdCount":{"type":"integer","minimum":0,"description":"Nodes created; with `dryRun`, rows that would be created (0 when every row already exists). A real import always creates at least one node."},"ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Ids of the created nodes, in request order; empty for a dry run."},"dryRun":{"type":"object","properties":{"created":{"type":"integer","minimum":0,"description":"Rows whose title is not in the target subtree yet."},"updated":{"type":"integer","minimum":0,"description":"Rows an import would change; always 0, an import only creates."},"unchanged":{"type":"integer","minimum":0,"description":"Rows whose title already exists in the target subtree."},"truncated":{"type":"boolean","description":"The existing-title scan hit its node cap, so some existing titles were not compared."}},"required":["created","updated","unchanged","truncated"],"description":"Present when the request asked for a dry run."}},"required":["createdCount","ids"],"description":"Result of a structure import."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `edit`/`manage` on the target node, or a guest attempting an internal mark).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, invisible nodes and without access, ADR-0005 §8).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Room is not active (read-only states answer 409 READ_ONLY, ADR-0005 §8).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/index/visible-counts":{"get":{"operationId":"getVisibleCounts","summary":"Room-level visible counts over the viewer’s visible nodes","description":"Returns the room-scoped aggregate over the live nodes the caller may read (T-261004-59f6, split from T-260914-0c7b AC leg 5, UX-L09): `documents` (`document` and `placeholder` nodes together), `folders`, and `maxVisibleDepth` (room-root children are depth 1; 0 when no node is visible). Hidden nodes are never counted and never leak through the totals: a guest in an external group learns nothing about an internal-area subtree, not even its existence (UX-L37, ADR-0005 §8). `numbersVisible` is the effective DOC-04 setting for the caller and never changes the counts. Listing is not a read of content, so this route writes no audit event and carries ids and counts only.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"The visible counts.","content":{"application/json":{"schema":{"type":"object","properties":{"numbersVisible":{"type":"boolean","description":"Effective DOC-04 setting for the caller; false hides index numbers but not the counts."},"documents":{"type":"integer","minimum":0,"description":"Visible `document` and `placeholder` nodes (placeholders are expected documents)."},"folders":{"type":"integer","minimum":0,"description":"Visible `folder` nodes."},"maxVisibleDepth":{"type":"integer","minimum":0,"description":"Depth of the deepest visible node (room-root children are depth 1; 0 when none visible)."}},"required":["numbersVisible","documents","folders","maxVisibleDepth"],"description":"Room-level visible counts over the viewer’s visible nodes only."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, invisible nodes and without access, ADR-0005 §8).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/index/trash":{"get":{"operationId":"listTrashedIndexNodes","summary":"List the trashed nodes of the room","description":"Lists the trashed nodes of the room, most recently trashed first (DOC-12). A trashed node keeps its title and former parent but has no index number or position, and is hidden from the tree, search and viewer (ADR-0012 D8.1). Requires `edit` on the room root, the `node.trash` level that moves a node of this room to the trash (ADR-0005 §5); a node whose former parent the caller may not see is omitted (§5). Restoring puts it back; permanent deletion follows the retention rules (ADR-0012) and stays out of this contract.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":500,"description":"Page size, 1-500 (default 200)."},"required":false,"description":"Page size, 1-500 (default 200).","name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":200,"description":"Opaque keyset cursor from the previous page."},"required":false,"description":"Opaque keyset cursor from the previous page.","name":"cursor","in":"query"}],"responses":{"200":{"description":"One page of trashed nodes.","content":{"application/json":{"schema":{"type":"object","properties":{"nodes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Index node id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"roomId":{"type":"string","format":"uuid","description":"Owning room."},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent folder; null at the room root."},"kind":{"type":"string","enum":["folder","document","placeholder"],"description":"Index node kind: folder, document or placeholder (expected document)."},"title":{"type":"string","nullable":true,"description":"Node title (client data)."},"indexNumber":{"type":"string","nullable":true,"maxLength":63,"pattern":"^[1-9]\\d*(\\.[1-9]\\d*)*$","description":"Position-derived number; null when the room hides numbers (DOC-04) or the node is trashed."},"position":{"type":"integer","nullable":true,"minimum":0,"description":"0-based sibling position; null while the node is trashed."},"internalMarked":{"type":"boolean","description":"Internal mark set on this node (ADR-0005 §6)."},"internalOnly":{"type":"boolean","description":"Materialised internal state: this node or an ancestor is marked."},"privileged":{"type":"boolean","description":"Legal privilege tag of a document node (RED-06, ADR-0040); guests never receive a privileged node. Absent means false."},"medicalMarked":{"type":"boolean","description":"Special-category zone mark (\"Medisch\") on this folder (ADR-0056). Absent means false."},"medicalOnly":{"type":"boolean","description":"This node lies in a special-category zone (this folder or an ancestor is marked). Absent means false."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Document row of a placeholder or document node; null for a folder (INT-F08, ADR-0007 D3). A placeholder carries the id of its empty row (`current_version_id` null), inserted with the node (T-260921-d705)."},"note":{"type":"string","nullable":true,"description":"Internal placeholder note (UX-L48); null for external groups."},"versionNo":{"type":"integer","nullable":true,"minimum":1,"description":"Number of the current version of a document node (DOC-06 badge); null or absent until a version is available and for folders and placeholders."},"approvalPending":{"type":"boolean","description":"True on a document uploaded with `upload_with_approval` that still waits for a manager (ADR-0026); only the uploader and managers see such a node. Absent otherwise."},"trashedAt":{"type":"string","nullable":true,"format":"date-time","description":"Set while the node is in the trash; null for live nodes."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."},"updatedAt":{"type":"string","format":"date-time","description":"Last structural change."}},"required":["id","tenantId","roomId","parentId","kind","title","indexNumber","position","internalMarked","internalOnly","documentId","note","trashedAt","createdAt","updatedAt"],"description":"One node of the room index tree (folder, document or placeholder)."},"description":"Trashed nodes, most recently trashed first."},"nextCursor":{"type":"string","nullable":true,"description":"Opaque cursor for the next page; null on the last page."}},"required":["nodes","nextCursor"],"description":"One page of trashed index nodes."}}}},"400":{"description":"Invalid query.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, invisible nodes and without access, ADR-0005 §8).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/index/{nodeId}":{"get":{"operationId":"getIndexNode","summary":"Read one index node","description":"Returns one live node the caller may see (ADR-0005 §5/§8). 404 hides existence, including cross-tenant and invisible nodes, and a trashed node: trashed nodes are not part of the live tree (ADR-0012 D8.1) and are reachable only through `listTrashedIndexNodes` and `restoreIndexNode`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Index node id."},"required":true,"description":"Index node id.","name":"nodeId","in":"path"}],"responses":{"200":{"description":"The node.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Index node id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"roomId":{"type":"string","format":"uuid","description":"Owning room."},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent folder; null at the room root."},"kind":{"type":"string","enum":["folder","document","placeholder"],"description":"Index node kind: folder, document or placeholder (expected document)."},"title":{"type":"string","nullable":true,"description":"Node title (client data)."},"indexNumber":{"type":"string","nullable":true,"maxLength":63,"pattern":"^[1-9]\\d*(\\.[1-9]\\d*)*$","description":"Position-derived number; null when the room hides numbers (DOC-04) or the node is trashed."},"position":{"type":"integer","nullable":true,"minimum":0,"description":"0-based sibling position; null while the node is trashed."},"internalMarked":{"type":"boolean","description":"Internal mark set on this node (ADR-0005 §6)."},"internalOnly":{"type":"boolean","description":"Materialised internal state: this node or an ancestor is marked."},"privileged":{"type":"boolean","description":"Legal privilege tag of a document node (RED-06, ADR-0040); guests never receive a privileged node. Absent means false."},"medicalMarked":{"type":"boolean","description":"Special-category zone mark (\"Medisch\") on this folder (ADR-0056). Absent means false."},"medicalOnly":{"type":"boolean","description":"This node lies in a special-category zone (this folder or an ancestor is marked). Absent means false."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Document row of a placeholder or document node; null for a folder (INT-F08, ADR-0007 D3). A placeholder carries the id of its empty row (`current_version_id` null), inserted with the node (T-260921-d705)."},"note":{"type":"string","nullable":true,"description":"Internal placeholder note (UX-L48); null for external groups."},"versionNo":{"type":"integer","nullable":true,"minimum":1,"description":"Number of the current version of a document node (DOC-06 badge); null or absent until a version is available and for folders and placeholders."},"approvalPending":{"type":"boolean","description":"True on a document uploaded with `upload_with_approval` that still waits for a manager (ADR-0026); only the uploader and managers see such a node. Absent otherwise."},"trashedAt":{"type":"string","nullable":true,"format":"date-time","description":"Set while the node is in the trash; null for live nodes."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."},"updatedAt":{"type":"string","format":"date-time","description":"Last structural change."}},"required":["id","tenantId","roomId","parentId","kind","title","indexNumber","position","internalMarked","internalOnly","documentId","note","trashedAt","createdAt","updatedAt"],"description":"One node of the room index tree (folder, document or placeholder)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, invisible nodes and without access, ADR-0005 §8).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"patch":{"operationId":"updateIndexNode","summary":"Rename a folder or a placeholder","description":"Renames a folder or a placeholder (UX-L47). Requires `node.rename` (`edit`, ADR-0005 §5) and an active room. Writes `index_node.renamed` (node id only). No body accepts a number: numbers follow position (UX-L45). A document node title is document metadata (DOC-11, T-260914-247b) and answers 409 CONFLICT.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Index node id."},"required":true,"description":"Index node id.","name":"nodeId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":255,"description":"Node title (folder name, document name or placeholder title); client data."}},"description":"Rename a folder or a placeholder."}}}},"responses":{"200":{"description":"The renamed node.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Index node id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"roomId":{"type":"string","format":"uuid","description":"Owning room."},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent folder; null at the room root."},"kind":{"type":"string","enum":["folder","document","placeholder"],"description":"Index node kind: folder, document or placeholder (expected document)."},"title":{"type":"string","nullable":true,"description":"Node title (client data)."},"indexNumber":{"type":"string","nullable":true,"maxLength":63,"pattern":"^[1-9]\\d*(\\.[1-9]\\d*)*$","description":"Position-derived number; null when the room hides numbers (DOC-04) or the node is trashed."},"position":{"type":"integer","nullable":true,"minimum":0,"description":"0-based sibling position; null while the node is trashed."},"internalMarked":{"type":"boolean","description":"Internal mark set on this node (ADR-0005 §6)."},"internalOnly":{"type":"boolean","description":"Materialised internal state: this node or an ancestor is marked."},"privileged":{"type":"boolean","description":"Legal privilege tag of a document node (RED-06, ADR-0040); guests never receive a privileged node. Absent means false."},"medicalMarked":{"type":"boolean","description":"Special-category zone mark (\"Medisch\") on this folder (ADR-0056). Absent means false."},"medicalOnly":{"type":"boolean","description":"This node lies in a special-category zone (this folder or an ancestor is marked). Absent means false."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Document row of a placeholder or document node; null for a folder (INT-F08, ADR-0007 D3). A placeholder carries the id of its empty row (`current_version_id` null), inserted with the node (T-260921-d705)."},"note":{"type":"string","nullable":true,"description":"Internal placeholder note (UX-L48); null for external groups."},"versionNo":{"type":"integer","nullable":true,"minimum":1,"description":"Number of the current version of a document node (DOC-06 badge); null or absent until a version is available and for folders and placeholders."},"approvalPending":{"type":"boolean","description":"True on a document uploaded with `upload_with_approval` that still waits for a manager (ADR-0026); only the uploader and managers see such a node. Absent otherwise."},"trashedAt":{"type":"string","nullable":true,"format":"date-time","description":"Set while the node is in the trash; null for live nodes."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."},"updatedAt":{"type":"string","format":"date-time","description":"Last structural change."}},"required":["id","tenantId","roomId","parentId","kind","title","indexNumber","position","internalMarked","internalOnly","documentId","note","trashedAt","createdAt","updatedAt"],"description":"One node of the room index tree (folder, document or placeholder)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `edit`/`manage` on the target node, or a guest attempting an internal mark).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, invisible nodes and without access, ADR-0005 §8).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Conflict or read-only: the node is a document node, whose title is document metadata (DOC-11, T-260914-247b) (code CONFLICT); a room that is not active answers 409 READ_ONLY (ADR-0005 §8). IDs and codes only.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/index/{nodeId}/move":{"post":{"operationId":"moveIndexNode","summary":"Move or reorder one index node","description":"Moves or reorders one node (UX-L46). Requires `node.move` (`edit` on both source and target, ADR-0005 §5) and an active room. The server recomputes the numbers of every affected sibling in the same transaction (UX-L45) and never accepts a number from the client. A cycle (a folder into its own subtree) answers 409 CONFLICT. The UX-L45 \"shared numbers change\" warning (at least one node an external group can currently view gets a new number) is a **client-side** ConfirmDialog computed from the same position rules, so the request carries no confirmation parameter and the server always returns the authoritative recomputed numbers (DOC-02, UX-L45). Leaving an `index_node` subtree under an active legal hold answers 409 LEGAL_HOLD (ADR-0012 D7, coverage follows the current path); a hold does not otherwise block a move. An invisible or trashed source or target stays 404 (ADR-0005 §10). Writes one `index_node.moved` (node id, parent ids and `batch_id` only) per moved node, sharing one `batch_id` (ADR-0006 D4).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Index node id."},"required":true,"description":"Index node id.","name":"nodeId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"parentId":{"type":"string","nullable":true,"format":"uuid","description":"New parent folder; null moves the node to the room root."},"position":{"oneOf":[{"type":"object","properties":{"at":{"type":"string","enum":["top"],"description":"Insert as the first child of the target parent."}},"required":["at"]},{"type":"object","properties":{"at":{"type":"string","enum":["bottom"],"description":"Insert as the last child of the target parent."}},"required":["at"]},{"type":"object","properties":{"at":{"type":"string","enum":["before"],"description":"Insert directly before this sibling."},"nodeId":{"type":"string","format":"uuid","description":"Current sibling under the same target parent."}},"required":["at","nodeId"]},{"type":"object","properties":{"at":{"type":"string","enum":["after"],"description":"Insert directly after this sibling."},"nodeId":{"type":"string","format":"uuid","description":"Current sibling under the same target parent."}},"required":["at","nodeId"]}],"description":"Target position inside the target parent (UX-L46)."}},"required":["parentId","position"],"description":"Move or reorder one index node (UX-L46)."}}}},"responses":{"200":{"description":"The moved node with its recomputed number.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Index node id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"roomId":{"type":"string","format":"uuid","description":"Owning room."},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent folder; null at the room root."},"kind":{"type":"string","enum":["folder","document","placeholder"],"description":"Index node kind: folder, document or placeholder (expected document)."},"title":{"type":"string","nullable":true,"description":"Node title (client data)."},"indexNumber":{"type":"string","nullable":true,"maxLength":63,"pattern":"^[1-9]\\d*(\\.[1-9]\\d*)*$","description":"Position-derived number; null when the room hides numbers (DOC-04) or the node is trashed."},"position":{"type":"integer","nullable":true,"minimum":0,"description":"0-based sibling position; null while the node is trashed."},"internalMarked":{"type":"boolean","description":"Internal mark set on this node (ADR-0005 §6)."},"internalOnly":{"type":"boolean","description":"Materialised internal state: this node or an ancestor is marked."},"privileged":{"type":"boolean","description":"Legal privilege tag of a document node (RED-06, ADR-0040); guests never receive a privileged node. Absent means false."},"medicalMarked":{"type":"boolean","description":"Special-category zone mark (\"Medisch\") on this folder (ADR-0056). Absent means false."},"medicalOnly":{"type":"boolean","description":"This node lies in a special-category zone (this folder or an ancestor is marked). Absent means false."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Document row of a placeholder or document node; null for a folder (INT-F08, ADR-0007 D3). A placeholder carries the id of its empty row (`current_version_id` null), inserted with the node (T-260921-d705)."},"note":{"type":"string","nullable":true,"description":"Internal placeholder note (UX-L48); null for external groups."},"versionNo":{"type":"integer","nullable":true,"minimum":1,"description":"Number of the current version of a document node (DOC-06 badge); null or absent until a version is available and for folders and placeholders."},"approvalPending":{"type":"boolean","description":"True on a document uploaded with `upload_with_approval` that still waits for a manager (ADR-0026); only the uploader and managers see such a node. Absent otherwise."},"trashedAt":{"type":"string","nullable":true,"format":"date-time","description":"Set while the node is in the trash; null for live nodes."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."},"updatedAt":{"type":"string","format":"date-time","description":"Last structural change."}},"required":["id","tenantId","roomId","parentId","kind","title","indexNumber","position","internalMarked","internalOnly","documentId","note","trashedAt","createdAt","updatedAt"],"description":"One node of the room index tree (folder, document or placeholder)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `edit`/`manage` on the target node, or a guest attempting an internal mark).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, invisible nodes and without access, ADR-0005 §8).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Conflict or read-only: the move would create a cycle (code CONFLICT); a room that is not active answers 409 READ_ONLY (ADR-0005 §8). Leaving a subtree under an active legal hold answers 409 LEGAL_HOLD (ADR-0012 D7). IDs and codes only.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/index/{nodeId}/copy":{"post":{"operationId":"copyIndexNode","summary":"Copy an index node structure (metadata only)","description":"Copies a node structure into the target folder (DOC-12). Metadata only: folders and placeholders are recreated (a copied placeholder gets its own empty document row, linked to the copy, INT-F08/T-260921-d705); `document` nodes are skipped (`skippedDocumentCount`) because a copy would need a real new version and object (ADR-0007, no object copies). Requires `edit` on both source and target (ADR-0005 §5) and an active room; a copied internal node stays internal (sticky, §6). Numbers are recomputed by position. Writes `index_node.created` per created node under one `batch_id` (node id and batch only, ADR-0006 D4).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Index node id."},"required":true,"description":"Index node id.","name":"nodeId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Target folder for the copy; null copies to the room root, omitted keeps the source parent."},"title":{"type":"string","minLength":1,"maxLength":255,"description":"Title of the copied root; defaults to \"<title> (copy)\"."}},"description":"Copy an index node structure (metadata only)."}}}},"responses":{"201":{"description":"The copied structure.","content":{"application/json":{"schema":{"type":"object","properties":{"root":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Index node id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"roomId":{"type":"string","format":"uuid","description":"Owning room."},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent folder; null at the room root."},"kind":{"type":"string","enum":["folder","document","placeholder"],"description":"Index node kind: folder, document or placeholder (expected document)."},"title":{"type":"string","nullable":true,"description":"Node title (client data)."},"indexNumber":{"type":"string","nullable":true,"maxLength":63,"pattern":"^[1-9]\\d*(\\.[1-9]\\d*)*$","description":"Position-derived number; null when the room hides numbers (DOC-04) or the node is trashed."},"position":{"type":"integer","nullable":true,"minimum":0,"description":"0-based sibling position; null while the node is trashed."},"internalMarked":{"type":"boolean","description":"Internal mark set on this node (ADR-0005 §6)."},"internalOnly":{"type":"boolean","description":"Materialised internal state: this node or an ancestor is marked."},"privileged":{"type":"boolean","description":"Legal privilege tag of a document node (RED-06, ADR-0040); guests never receive a privileged node. Absent means false."},"medicalMarked":{"type":"boolean","description":"Special-category zone mark (\"Medisch\") on this folder (ADR-0056). Absent means false."},"medicalOnly":{"type":"boolean","description":"This node lies in a special-category zone (this folder or an ancestor is marked). Absent means false."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Document row of a placeholder or document node; null for a folder (INT-F08, ADR-0007 D3). A placeholder carries the id of its empty row (`current_version_id` null), inserted with the node (T-260921-d705)."},"note":{"type":"string","nullable":true,"description":"Internal placeholder note (UX-L48); null for external groups."},"versionNo":{"type":"integer","nullable":true,"minimum":1,"description":"Number of the current version of a document node (DOC-06 badge); null or absent until a version is available and for folders and placeholders."},"approvalPending":{"type":"boolean","description":"True on a document uploaded with `upload_with_approval` that still waits for a manager (ADR-0026); only the uploader and managers see such a node. Absent otherwise."},"trashedAt":{"type":"string","nullable":true,"format":"date-time","description":"Set while the node is in the trash; null for live nodes."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."},"updatedAt":{"type":"string","format":"date-time","description":"Last structural change."}},"required":["id","tenantId","roomId","parentId","kind","title","indexNumber","position","internalMarked","internalOnly","documentId","note","trashedAt","createdAt","updatedAt"],"description":"The copied root node (a new node)."},"copiedCount":{"type":"integer","minimum":0,"description":"Number of nodes created by the copy, including the root."},"skippedDocumentCount":{"type":"integer","minimum":0,"description":"Document nodes that were not copied (metadata only); placeholders are recreated empty."}},"required":["root","copiedCount","skippedDocumentCount"],"description":"Result of a structure copy."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `edit`/`manage` on the target node, or a guest attempting an internal mark).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, invisible nodes and without access, ADR-0005 §8).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Conflict or read-only: a folder is copied into its own subtree (code CONFLICT); a room that is not active answers 409 READ_ONLY (ADR-0005 §8). IDs and codes only.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/index/{nodeId}/trash":{"post":{"operationId":"trashIndexNode","summary":"Move a node and its subtree to the trash","description":"Moves one node and its subtree to the trash (DOC-12, UX-L18). Requires `node.trash` (`edit`, ADR-0005 §5) and an active room. A legal hold does **not** block this: trash is not deletion, so a held node can be trashed by a user (ADR-0012 D7). A node an open flow item uses is refused with 409 ITEM_NODE_IN_USE (upload-flow INT-F08). Trashing is reversible through `restore`; permanent deletion is the retention path (ADR-0012) and the audit trail stays append-only. Writes `index_node.trashed` (node id and an optional reason code only).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Index node id."},"required":true,"description":"Index node id.","name":"nodeId","in":"path"}],"responses":{"200":{"description":"The trashed node (no number or position).","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Index node id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"roomId":{"type":"string","format":"uuid","description":"Owning room."},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent folder; null at the room root."},"kind":{"type":"string","enum":["folder","document","placeholder"],"description":"Index node kind: folder, document or placeholder (expected document)."},"title":{"type":"string","nullable":true,"description":"Node title (client data)."},"indexNumber":{"type":"string","nullable":true,"maxLength":63,"pattern":"^[1-9]\\d*(\\.[1-9]\\d*)*$","description":"Position-derived number; null when the room hides numbers (DOC-04) or the node is trashed."},"position":{"type":"integer","nullable":true,"minimum":0,"description":"0-based sibling position; null while the node is trashed."},"internalMarked":{"type":"boolean","description":"Internal mark set on this node (ADR-0005 §6)."},"internalOnly":{"type":"boolean","description":"Materialised internal state: this node or an ancestor is marked."},"privileged":{"type":"boolean","description":"Legal privilege tag of a document node (RED-06, ADR-0040); guests never receive a privileged node. Absent means false."},"medicalMarked":{"type":"boolean","description":"Special-category zone mark (\"Medisch\") on this folder (ADR-0056). Absent means false."},"medicalOnly":{"type":"boolean","description":"This node lies in a special-category zone (this folder or an ancestor is marked). Absent means false."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Document row of a placeholder or document node; null for a folder (INT-F08, ADR-0007 D3). A placeholder carries the id of its empty row (`current_version_id` null), inserted with the node (T-260921-d705)."},"note":{"type":"string","nullable":true,"description":"Internal placeholder note (UX-L48); null for external groups."},"versionNo":{"type":"integer","nullable":true,"minimum":1,"description":"Number of the current version of a document node (DOC-06 badge); null or absent until a version is available and for folders and placeholders."},"approvalPending":{"type":"boolean","description":"True on a document uploaded with `upload_with_approval` that still waits for a manager (ADR-0026); only the uploader and managers see such a node. Absent otherwise."},"trashedAt":{"type":"string","nullable":true,"format":"date-time","description":"Set while the node is in the trash; null for live nodes."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."},"updatedAt":{"type":"string","format":"date-time","description":"Last structural change."}},"required":["id","tenantId","roomId","parentId","kind","title","indexNumber","position","internalMarked","internalOnly","documentId","note","trashedAt","createdAt","updatedAt"],"description":"One node of the room index tree (folder, document or placeholder)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `edit`/`manage` on the target node, or a guest attempting an internal mark).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, invisible nodes and without access, ADR-0005 §8).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Conflict or read-only: an open flow item still uses this node (code ITEM_NODE_IN_USE); a room that is not active answers 409 READ_ONLY (ADR-0005 §8). IDs and codes only.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/index/{nodeId}/restore":{"post":{"operationId":"restoreIndexNode","summary":"Restore a trashed node","description":"Restores a trashed node to the parent it was trashed from, as the last child; the numbers of the affected siblings are recomputed in the same transaction (DOC-12, UX-L45). Requires `edit` on that parent (ADR-0005 §5) and an active room. Restoring a node whose former parent is itself trashed answers 409 CONFLICT (restore the parent first). A document trashed by retention expiry stays refused with 409 RETENTION_EXPIRED until a manual class or extension makes it not expired (ADR-0012 D8.1). Writes `index_node.restored`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Index node id."},"required":true,"description":"Index node id.","name":"nodeId","in":"path"}],"responses":{"200":{"description":"The restored node with its recomputed number.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Index node id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"roomId":{"type":"string","format":"uuid","description":"Owning room."},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent folder; null at the room root."},"kind":{"type":"string","enum":["folder","document","placeholder"],"description":"Index node kind: folder, document or placeholder (expected document)."},"title":{"type":"string","nullable":true,"description":"Node title (client data)."},"indexNumber":{"type":"string","nullable":true,"maxLength":63,"pattern":"^[1-9]\\d*(\\.[1-9]\\d*)*$","description":"Position-derived number; null when the room hides numbers (DOC-04) or the node is trashed."},"position":{"type":"integer","nullable":true,"minimum":0,"description":"0-based sibling position; null while the node is trashed."},"internalMarked":{"type":"boolean","description":"Internal mark set on this node (ADR-0005 §6)."},"internalOnly":{"type":"boolean","description":"Materialised internal state: this node or an ancestor is marked."},"privileged":{"type":"boolean","description":"Legal privilege tag of a document node (RED-06, ADR-0040); guests never receive a privileged node. Absent means false."},"medicalMarked":{"type":"boolean","description":"Special-category zone mark (\"Medisch\") on this folder (ADR-0056). Absent means false."},"medicalOnly":{"type":"boolean","description":"This node lies in a special-category zone (this folder or an ancestor is marked). Absent means false."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Document row of a placeholder or document node; null for a folder (INT-F08, ADR-0007 D3). A placeholder carries the id of its empty row (`current_version_id` null), inserted with the node (T-260921-d705)."},"note":{"type":"string","nullable":true,"description":"Internal placeholder note (UX-L48); null for external groups."},"versionNo":{"type":"integer","nullable":true,"minimum":1,"description":"Number of the current version of a document node (DOC-06 badge); null or absent until a version is available and for folders and placeholders."},"approvalPending":{"type":"boolean","description":"True on a document uploaded with `upload_with_approval` that still waits for a manager (ADR-0026); only the uploader and managers see such a node. Absent otherwise."},"trashedAt":{"type":"string","nullable":true,"format":"date-time","description":"Set while the node is in the trash; null for live nodes."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."},"updatedAt":{"type":"string","format":"date-time","description":"Last structural change."}},"required":["id","tenantId","roomId","parentId","kind","title","indexNumber","position","internalMarked","internalOnly","documentId","note","trashedAt","createdAt","updatedAt"],"description":"One node of the room index tree (folder, document or placeholder)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `edit`/`manage` on the target node, or a guest attempting an internal mark).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, invisible nodes and without access, ADR-0005 §8).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Conflict or read-only: the parent it was trashed from is itself trashed (code CONFLICT); a room that is not active answers 409 READ_ONLY (ADR-0005 §8). A document trashed by retention expiry answers 409 RETENTION_EXPIRED until a manual class or extension clears it (ADR-0012 D8.1). IDs and codes only.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/index/selection/resolve":{"post":{"operationId":"resolveBulkSelection","summary":"Resolve a caller-described bulk selection to node ids","description":"Resolves a folder-view (one subtree) or flat-view (whole room) selection to concrete node ids for a later move/download/trash/permission job (UX-L17, T-261004-68b0). Requires `node.read` on the selection root; every candidate is re-checked with `node.read` per node, so hidden nodes appear in neither `ids` nor `total` — not even as a zero-vs-nonzero count — and a guest cannot tell an internal subtree from a missing one (404, ADR-0005 §10). The room root is never selectable. Listing only: no audit event is written and the response carries ids and counts, never titles, notes or file names.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"view":{"type":"string","enum":["folder","flat"],"description":"Bulk selection view: folder (one subtree) or flat (whole room)."},"folderId":{"type":"string","nullable":true,"format":"uuid","description":"Subtree root for view=folder; null or omitted means the room root."},"includeSubfolders":{"type":"boolean","default":true,"description":"When false, only direct children of the folder view match."},"kinds":{"type":"array","items":{"type":"string","enum":["folder","document","placeholder"],"description":"Index node kind: folder, document or placeholder (expected document)."},"maxItems":3,"description":"Restrict the selection to these node kinds; omitted means every kind."},"excludeIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":200,"default":[],"description":"Explicitly excluded node ids (picker checkboxes)."},"limit":{"type":"integer","minimum":1,"maximum":1000,"default":200,"description":"Maximum resolved ids to return; the response reports truncation."}},"required":["view"],"description":"Caller-described bulk selection; the server resolves it with per-node rights checks."}}}},"responses":{"200":{"description":"The resolved selection (ids only).","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Resolved node ids in deterministic order, exclusions applied."},"total":{"type":"integer","minimum":0,"description":"Nodes matching the selection after rights checks and exclusions."},"truncated":{"type":"boolean","description":"True when total exceeds the returned ids (limit hit)."}},"required":["ids","total","truncated"],"description":"Resolved bulk selection."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, invisible nodes and without access, ADR-0005 §8).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/index/export":{"get":{"operationId":"exportRoomIndex","summary":"Download the visible room index as XLSX or PDF","description":"Downloads the room index the caller may see as an XLSX workbook or a PDF document (T-260914-463a, DOC-13). Columns are the index number (null when DOC-04 hides numbers for the caller), title, node kind, node version and last change; document date, status, tags and per-group permissions need the document-metadata join and stay on the async worker slice. Every row passes the same per-node `node.read` check as the listing, so hidden/internal nodes never reach the file. Requires `node.read` on the room root (invisible rooms answer 404, ADR-0005 §8). Writes `export.downloaded` with `export_kind: index` (ids and the row count only, never titles).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","enum":["xlsx","pdf"],"description":"Export file format."},"required":true,"description":"Export file format.","name":"format","in":"query"},{"schema":{"type":"string","enum":["nl","en"],"description":"Label language of the file headings; defaults to nl."},"required":false,"description":"Label language of the file headings; defaults to nl.","name":"locale","in":"query"}],"responses":{"200":{"description":"The index file as an attachment.","content":{"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string"}},"application/pdf":{"schema":{"type":"string"}}}},"400":{"description":"Invalid query.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, invisible nodes and without access, ADR-0005 §8).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/archive":{"post":{"operationId":"archiveRoom","summary":"Archive a closed room (read-only, retention keeps running)","description":"Moves a `closed` room to `archived` (T-261004-d3da, MAT-11): the missing writer for the `archived` state the vocabulary and the destruction guard already declare. The retention clock keeps running from the `room_closed` trigger; the storage tier stays local metadata in this slice. Decided on `room.close` (`manage` on the room root or `firm_admin`), like closing; writes `room.archive`. 409 CONFLICT when the room is not closed.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"The room retention surface after archiving.","content":{"application/json":{"schema":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid","description":"Room id."},"state":{"type":"string","enum":["active","frozen","closed","archived"],"description":"Room state; closing starts the retention clock (ADR-0012 D3)."},"closedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the current `room_closed` trigger was recorded (the clock start), or null."},"retentionUntil":{"type":"string","nullable":true,"format":"date","description":"Room retention_until (Europe/Amsterdam date); null means no expiry yet."},"retentionFloor":{"type":"string","nullable":true,"format":"date","description":"Latest date ever computed for the room."},"retentionEvaluatedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the date was last recomputed."},"expired":{"type":"boolean","description":"True when today (Europe/Amsterdam) is after retention_until (ADR-0012 D1)."},"eligibleForDestruction":{"type":"boolean","description":"Closed or archived, expired, no hold (grace included) and no open procedure (D8.5)."},"recordClasses":{"type":"array","items":{"type":"object","properties":{"classId":{"type":"string","enum":["legal_file","legal_financial_record","legal_liability_long","wwft_cdd","mortgage_advice_file","mortgage_supporting","mortgage_identity_copy","general_room","notary_file","notary_environmental","accountancy_record","financial_advice_file","mifid_record","mediation_file","insolvency_estate"],"description":"Platform retention class id (ADR-0012 D2); tenants cannot create classes in the MVP."},"source":{"type":"string","enum":["room_type","manual"],"description":"How the class was assigned (append-only)."},"effectiveDuration":{"type":"string","pattern":"^P(?!$)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)W)?(?:(\\d+)D)?$","description":"Tenant duration of the class, or its default."},"assignedAt":{"type":"string","format":"date-time","description":"Assignment timestamp (UTC, ISO-8601)."},"assignedBy":{"type":"string","nullable":true,"format":"uuid","description":"Principal that assigned the class, or null for a rule."}},"required":["classId","source","effectiveDuration","assignedAt","assignedBy"],"additionalProperties":false,"description":"One class of the room records (ADR-0012 D4); append-only."},"description":"Classes of the room records (index, messages, notes), append-only."},"hold":{"type":"object","properties":{"active":{"type":"boolean","description":"True when at least one hold covers the item."},"holdCount":{"type":"integer","minimum":0,"description":"Number of holds that cover the item."},"graceEndsAt":{"type":"string","nullable":true,"format":"date-time","description":"Latest grace end of a lifted hold that still covers the item, or null."}},"required":["active","holdCount","graceEndsAt"],"additionalProperties":false,"description":"Hold-state projection on a retention surface; ids and dates only (ADR-0012 D7)."},"destruction":{"type":"object","nullable":true,"properties":{"requestId":{"type":"string","format":"uuid","description":"Deletion request id."},"status":{"type":"string","enum":["requested","approved","executing","completed","failed"],"description":"Deletion request status (ADR-0012 D10)."},"coolingOffUntil":{"type":"string","nullable":true,"format":"date-time","description":"End of the 72-hour cooling-off, or null."}},"required":["requestId","status","coolingOffUntil"],"additionalProperties":false,"description":"Open or completed destruction request."}},"required":["roomId","state","closedAt","retentionUntil","retentionFloor","retentionEvaluatedAt","expired","eligibleForDestruction","recordClasses","hold","destruction"],"additionalProperties":false,"description":"Retention surface of one room; ids, dates and codes only."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no firm_admin/compliance right, a guest or support session, or step-up required: 401 STEP_UP_REQUIRED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, hidden, or cross-tenant: the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Conflict (code CONFLICT); ADR-0012 D11.1 decision order, a hold is always reported first.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/freeze":{"post":{"operationId":"freezeRoom","summary":"Freeze a room (read-only) without starting its retention clock","description":"Moves an `active` room to `frozen` (read-only) without recording a retention trigger (T-260914-64db, MAT-10). Decided on `room.close` (`manage` on the room root or `firm_admin`), like closing; writes `room.state_changed` (`active` -> `frozen`). 409 CONFLICT when the room is not active.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"The room retention surface after freezing.","content":{"application/json":{"schema":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid","description":"Room id."},"state":{"type":"string","enum":["active","frozen","closed","archived"],"description":"Room state; closing starts the retention clock (ADR-0012 D3)."},"closedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the current `room_closed` trigger was recorded (the clock start), or null."},"retentionUntil":{"type":"string","nullable":true,"format":"date","description":"Room retention_until (Europe/Amsterdam date); null means no expiry yet."},"retentionFloor":{"type":"string","nullable":true,"format":"date","description":"Latest date ever computed for the room."},"retentionEvaluatedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the date was last recomputed."},"expired":{"type":"boolean","description":"True when today (Europe/Amsterdam) is after retention_until (ADR-0012 D1)."},"eligibleForDestruction":{"type":"boolean","description":"Closed or archived, expired, no hold (grace included) and no open procedure (D8.5)."},"recordClasses":{"type":"array","items":{"type":"object","properties":{"classId":{"type":"string","enum":["legal_file","legal_financial_record","legal_liability_long","wwft_cdd","mortgage_advice_file","mortgage_supporting","mortgage_identity_copy","general_room","notary_file","notary_environmental","accountancy_record","financial_advice_file","mifid_record","mediation_file","insolvency_estate"],"description":"Platform retention class id (ADR-0012 D2); tenants cannot create classes in the MVP."},"source":{"type":"string","enum":["room_type","manual"],"description":"How the class was assigned (append-only)."},"effectiveDuration":{"type":"string","pattern":"^P(?!$)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)W)?(?:(\\d+)D)?$","description":"Tenant duration of the class, or its default."},"assignedAt":{"type":"string","format":"date-time","description":"Assignment timestamp (UTC, ISO-8601)."},"assignedBy":{"type":"string","nullable":true,"format":"uuid","description":"Principal that assigned the class, or null for a rule."}},"required":["classId","source","effectiveDuration","assignedAt","assignedBy"],"additionalProperties":false,"description":"One class of the room records (ADR-0012 D4); append-only."},"description":"Classes of the room records (index, messages, notes), append-only."},"hold":{"type":"object","properties":{"active":{"type":"boolean","description":"True when at least one hold covers the item."},"holdCount":{"type":"integer","minimum":0,"description":"Number of holds that cover the item."},"graceEndsAt":{"type":"string","nullable":true,"format":"date-time","description":"Latest grace end of a lifted hold that still covers the item, or null."}},"required":["active","holdCount","graceEndsAt"],"additionalProperties":false,"description":"Hold-state projection on a retention surface; ids and dates only (ADR-0012 D7)."},"destruction":{"type":"object","nullable":true,"properties":{"requestId":{"type":"string","format":"uuid","description":"Deletion request id."},"status":{"type":"string","enum":["requested","approved","executing","completed","failed"],"description":"Deletion request status (ADR-0012 D10)."},"coolingOffUntil":{"type":"string","nullable":true,"format":"date-time","description":"End of the 72-hour cooling-off, or null."}},"required":["requestId","status","coolingOffUntil"],"additionalProperties":false,"description":"Open or completed destruction request."}},"required":["roomId","state","closedAt","retentionUntil","retentionFloor","retentionEvaluatedAt","expired","eligibleForDestruction","recordClasses","hold","destruction"],"additionalProperties":false,"description":"Retention surface of one room; ids, dates and codes only."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no firm_admin/compliance right, a guest or support session, or step-up required: 401 STEP_UP_REQUIRED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, hidden, or cross-tenant: the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Conflict (code CONFLICT); ADR-0012 D11.1 decision order, a hold is always reported first.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/reactivate":{"post":{"operationId":"reactivateRoom","summary":"Reactivate a frozen room without a support call","description":"Moves a `frozen` room back to `active` (T-260914-64db, MAT-12). Decided on `room.reactivate` (`firm_admin`); writes `room.state_changed` (`frozen` -> `active`). 409 CONFLICT when the room is not frozen.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"The room retention surface after reactivation.","content":{"application/json":{"schema":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid","description":"Room id."},"state":{"type":"string","enum":["active","frozen","closed","archived"],"description":"Room state; closing starts the retention clock (ADR-0012 D3)."},"closedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the current `room_closed` trigger was recorded (the clock start), or null."},"retentionUntil":{"type":"string","nullable":true,"format":"date","description":"Room retention_until (Europe/Amsterdam date); null means no expiry yet."},"retentionFloor":{"type":"string","nullable":true,"format":"date","description":"Latest date ever computed for the room."},"retentionEvaluatedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the date was last recomputed."},"expired":{"type":"boolean","description":"True when today (Europe/Amsterdam) is after retention_until (ADR-0012 D1)."},"eligibleForDestruction":{"type":"boolean","description":"Closed or archived, expired, no hold (grace included) and no open procedure (D8.5)."},"recordClasses":{"type":"array","items":{"type":"object","properties":{"classId":{"type":"string","enum":["legal_file","legal_financial_record","legal_liability_long","wwft_cdd","mortgage_advice_file","mortgage_supporting","mortgage_identity_copy","general_room","notary_file","notary_environmental","accountancy_record","financial_advice_file","mifid_record","mediation_file","insolvency_estate"],"description":"Platform retention class id (ADR-0012 D2); tenants cannot create classes in the MVP."},"source":{"type":"string","enum":["room_type","manual"],"description":"How the class was assigned (append-only)."},"effectiveDuration":{"type":"string","pattern":"^P(?!$)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)W)?(?:(\\d+)D)?$","description":"Tenant duration of the class, or its default."},"assignedAt":{"type":"string","format":"date-time","description":"Assignment timestamp (UTC, ISO-8601)."},"assignedBy":{"type":"string","nullable":true,"format":"uuid","description":"Principal that assigned the class, or null for a rule."}},"required":["classId","source","effectiveDuration","assignedAt","assignedBy"],"additionalProperties":false,"description":"One class of the room records (ADR-0012 D4); append-only."},"description":"Classes of the room records (index, messages, notes), append-only."},"hold":{"type":"object","properties":{"active":{"type":"boolean","description":"True when at least one hold covers the item."},"holdCount":{"type":"integer","minimum":0,"description":"Number of holds that cover the item."},"graceEndsAt":{"type":"string","nullable":true,"format":"date-time","description":"Latest grace end of a lifted hold that still covers the item, or null."}},"required":["active","holdCount","graceEndsAt"],"additionalProperties":false,"description":"Hold-state projection on a retention surface; ids and dates only (ADR-0012 D7)."},"destruction":{"type":"object","nullable":true,"properties":{"requestId":{"type":"string","format":"uuid","description":"Deletion request id."},"status":{"type":"string","enum":["requested","approved","executing","completed","failed"],"description":"Deletion request status (ADR-0012 D10)."},"coolingOffUntil":{"type":"string","nullable":true,"format":"date-time","description":"End of the 72-hour cooling-off, or null."}},"required":["requestId","status","coolingOffUntil"],"additionalProperties":false,"description":"Open or completed destruction request."}},"required":["roomId","state","closedAt","retentionUntil","retentionFloor","retentionEvaluatedAt","expired","eligibleForDestruction","recordClasses","hold","destruction"],"additionalProperties":false,"description":"Retention surface of one room; ids, dates and codes only."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no firm_admin/compliance right, a guest or support session, or step-up required: 401 STEP_UP_REQUIRED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, hidden, or cross-tenant: the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Conflict (code CONFLICT); ADR-0012 D11.1 decision order, a hold is always reported first.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/support/requests":{"post":{"operationId":"createSupportRequest","summary":"Submit a support request","description":"A firm user contacts DutchDataroom support without granting access to any document (T-260914-f982, OPS-06): a coded category, a subject and a free-text description. The UI asks the firm not to include client data; the description never reaches a log, an audit record or a metric. Requires support_request.create; guests and support principals get 403. Writes support_request.created.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"type":"string","enum":["question","technical","billing","account","other"],"description":"What the request is about (code)."},"subject":{"type":"string","minLength":1,"maxLength":120,"description":"One-line subject; the UI asks the firm not to include client data."},"description":{"type":"string","minLength":1,"maxLength":4000,"description":"Free text; never reaches a log, an audit record or a metric."}},"required":["category","subject","description"],"description":"Submit a support request."}}}},"responses":{"201":{"description":"The submitted request.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Request id."},"category":{"type":"string","enum":["question","technical","billing","account","other"],"description":"What the request is about (code)."},"subject":{"type":"string","minLength":1,"maxLength":120},"description":{"type":"string","minLength":1,"maxLength":4000},"status":{"type":"string","enum":["submitted","in_progress","resolved","closed"],"description":"Where the request is in its lifecycle."},"createdAt":{"type":"string","format":"date-time","description":"When the firm submitted it."},"updatedAt":{"type":"string","format":"date-time","description":"When the status last changed."}},"required":["id","category","subject","description","status","createdAt","updatedAt"],"description":"A firm support request."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Guest or support principal.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"get":{"operationId":"listSupportRequests","summary":"List the support requests of a tenant","description":"The requests of one tenant, newest first (T-260914-f982). A firm user (support_request.read) sees the full request including its own free text. A support principal reaches the same path through an active tenant_metadata grant and receives the console projection: tenant metadata only, never the subject or the description. 404 hides existence, including cross-tenant.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"The tenant requests; the console projection for a support principal.","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"requests":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Request id."},"category":{"type":"string","enum":["question","technical","billing","account","other"],"description":"What the request is about (code)."},"subject":{"type":"string","minLength":1,"maxLength":120},"description":{"type":"string","minLength":1,"maxLength":4000},"status":{"type":"string","enum":["submitted","in_progress","resolved","closed"],"description":"Where the request is in its lifecycle."},"createdAt":{"type":"string","format":"date-time","description":"When the firm submitted it."},"updatedAt":{"type":"string","format":"date-time","description":"When the status last changed."}},"required":["id","category","subject","description","status","createdAt","updatedAt"],"description":"A firm support request."},"description":"The tenant requests, newest first."}},"required":["requests"],"description":"Support requests of one tenant."},{"type":"object","properties":{"requests":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"tenantId":{"type":"string","format":"uuid"},"category":{"type":"string","enum":["question","technical","billing","account","other"],"description":"What the request is about (code)."},"status":{"type":"string","enum":["submitted","in_progress","resolved","closed"],"description":"Where the request is in its lifecycle."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","tenantId","category","status","createdAt","updatedAt"],"description":"One support request as the platform console shows it (metadata only)."},"description":"Requests of the granted tenant, newest first."}},"required":["requests"],"description":"Support requests for the support console (tenant metadata only)."}]}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Guest (no firm role).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, or a support principal without a grant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/support/requests/{requestId}/status":{"post":{"operationId":"updateSupportRequestStatus","summary":"Advance a support request","description":"A firm admin advances the request status (T-260914-f982). The machine is forward only: submitted -> in_progress/resolved/closed, in_progress -> resolved/closed, resolved -> closed; an unknown transition on a resolved or closed request answers 409 CONFLICT. Requires support_request.update. Writes support_request.updated.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Support request id."},"required":true,"description":"Support request id.","name":"requestId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["in_progress","resolved","closed"],"description":"New status for a support request."}},"required":["status"],"description":"Advance a support request."}}}},"responses":{"200":{"description":"The updated request.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Request id."},"category":{"type":"string","enum":["question","technical","billing","account","other"],"description":"What the request is about (code)."},"subject":{"type":"string","minLength":1,"maxLength":120},"description":{"type":"string","minLength":1,"maxLength":4000},"status":{"type":"string","enum":["submitted","in_progress","resolved","closed"],"description":"Where the request is in its lifecycle."},"createdAt":{"type":"string","format":"date-time","description":"When the firm submitted it."},"updatedAt":{"type":"string","format":"date-time","description":"When the status last changed."}},"required":["id","category","subject","description","status","createdAt","updatedAt"],"description":"A firm support request."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Not a firm admin.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"The request cannot move to that status (code CONFLICT).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/support/grants/requests":{"post":{"operationId":"createSupportGrantRequest","summary":"Ask for a time-limited support grant","description":"A support principal asks a firm for break-glass access (T-260914-ac21, ADR-0005 §1): a scope, an optional room, a coded reason and a requested window of at most 24 hours. There is no data access until a firm admin approves. The tenant is the path parameter, so the route guard resolves the tenant facts before the body is validated. Writes support_grant.requested. Only principals of kind support may call this (support_access.request); users and guests get 403/404.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"scope":{"type":"string","enum":["tenant_metadata","room_read"],"description":"What the grant allows: tenant metadata, or read access inside one named room."},"roomId":{"type":"string","nullable":true,"format":"uuid","description":"Required for scope room_read; null otherwise."},"includeInternal":{"type":"boolean","description":"Room scope only: also cover internal-marked nodes (ADR-0005 §9)."},"reasonCode":{"type":"string","enum":["customer_request","incident","technical_support","data_recovery","other"],"description":"Why support access is asked (code, never free text)."},"durationHours":{"type":"integer","minimum":1,"maximum":24,"description":"Requested window in hours (1..24); the firm grants the final window."}},"required":["scope","reasonCode","durationHours"],"description":"Ask for a time-limited support grant."}}}},"responses":{"201":{"description":"The pending grant.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Grant id."},"tenantId":{"type":"string","format":"uuid","description":"Tenant the grant is for."},"scope":{"type":"string","enum":["tenant_metadata","room_read"],"description":"What the grant allows: tenant metadata, or read access inside one named room."},"roomId":{"type":"string","nullable":true,"format":"uuid","description":"Room for scope room_read; null otherwise."},"includeInternal":{"type":"boolean","description":"Whether internal-marked nodes are covered."},"status":{"type":"string","enum":["pending","active","expired","denied","revoked"],"description":"Grant state at read time (expired is derived from expiresAt and the clock)."},"reasonCode":{"type":"string","enum":["customer_request","incident","technical_support","data_recovery","other"],"description":"Why support access is asked (code, never free text)."},"requestedDurationHours":{"type":"integer","nullable":true,"minimum":1,"maximum":24,"description":"Window the support principal asked for; null for rows that predate this field."},"requestedAt":{"type":"string","format":"date-time","description":"When the request was made."},"approvedAt":{"type":"string","nullable":true,"format":"date-time","description":"When a firm admin approved or denied it."},"startsAt":{"type":"string","nullable":true,"format":"date-time","description":"Start of the granted window."},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"End of the granted window."},"revokedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the firm revoked it."}},"required":["id","tenantId","scope","roomId","includeInternal","status","reasonCode","requestedDurationHours","requestedAt","approvedAt","startsAt","expiresAt","revokedAt"],"description":"A break-glass support grant."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Not a support principal.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (users and guests; no existence leak).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"This support principal already has a pending request (code CONFLICT).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/support/grants":{"get":{"operationId":"listSupportGrants","summary":"List the support grants of a tenant","description":"Pending and decided break-glass grants of one tenant, newest first (T-260914-ac21). Firm admins only (support_access.read); 404 hides existence, including cross-tenant (PERM-02). Reads the reason code and the window, never client content.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"The grants of the tenant.","content":{"application/json":{"schema":{"type":"object","properties":{"grants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Grant id."},"tenantId":{"type":"string","format":"uuid","description":"Tenant the grant is for."},"scope":{"type":"string","enum":["tenant_metadata","room_read"],"description":"What the grant allows: tenant metadata, or read access inside one named room."},"roomId":{"type":"string","nullable":true,"format":"uuid","description":"Room for scope room_read; null otherwise."},"includeInternal":{"type":"boolean","description":"Whether internal-marked nodes are covered."},"status":{"type":"string","enum":["pending","active","expired","denied","revoked"],"description":"Grant state at read time (expired is derived from expiresAt and the clock)."},"reasonCode":{"type":"string","enum":["customer_request","incident","technical_support","data_recovery","other"],"description":"Why support access is asked (code, never free text)."},"requestedDurationHours":{"type":"integer","nullable":true,"minimum":1,"maximum":24,"description":"Window the support principal asked for; null for rows that predate this field."},"requestedAt":{"type":"string","format":"date-time","description":"When the request was made."},"approvedAt":{"type":"string","nullable":true,"format":"date-time","description":"When a firm admin approved or denied it."},"startsAt":{"type":"string","nullable":true,"format":"date-time","description":"Start of the granted window."},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"End of the granted window."},"revokedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the firm revoked it."}},"required":["id","tenantId","scope","roomId","includeInternal","status","reasonCode","requestedDurationHours","requestedAt","approvedAt","startsAt","expiresAt","revokedAt"],"description":"A break-glass support grant."},"description":"Pending and decided grants of the tenant, newest first."}},"required":["grants"],"description":"Support grants of one tenant."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Not a firm admin.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/support/grants/{grantId}/approve":{"post":{"operationId":"approveSupportGrant","summary":"Approve a support request","description":"A firm admin approves a pending request and sets the window (at most 24 hours from now). Requires support_access.approve with step-up (ADR-0003 D5). A request that is already decided answers 409 CONFLICT. Writes support_grant.approved.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Support grant id."},"required":true,"description":"Support grant id.","name":"grantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"durationHours":{"type":"integer","minimum":1,"maximum":24,"description":"Granted window in hours (1..24); starts now."}},"required":["durationHours"],"description":"Approve a pending support request."}}}},"responses":{"200":{"description":"The active grant.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Grant id."},"tenantId":{"type":"string","format":"uuid","description":"Tenant the grant is for."},"scope":{"type":"string","enum":["tenant_metadata","room_read"],"description":"What the grant allows: tenant metadata, or read access inside one named room."},"roomId":{"type":"string","nullable":true,"format":"uuid","description":"Room for scope room_read; null otherwise."},"includeInternal":{"type":"boolean","description":"Whether internal-marked nodes are covered."},"status":{"type":"string","enum":["pending","active","expired","denied","revoked"],"description":"Grant state at read time (expired is derived from expiresAt and the clock)."},"reasonCode":{"type":"string","enum":["customer_request","incident","technical_support","data_recovery","other"],"description":"Why support access is asked (code, never free text)."},"requestedDurationHours":{"type":"integer","nullable":true,"minimum":1,"maximum":24,"description":"Window the support principal asked for; null for rows that predate this field."},"requestedAt":{"type":"string","format":"date-time","description":"When the request was made."},"approvedAt":{"type":"string","nullable":true,"format":"date-time","description":"When a firm admin approved or denied it."},"startsAt":{"type":"string","nullable":true,"format":"date-time","description":"Start of the granted window."},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"End of the granted window."},"revokedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the firm revoked it."}},"required":["id","tenantId","scope","roomId","includeInternal","status","reasonCode","requestedDurationHours","requestedAt","approvedAt","startsAt","expiresAt","revokedAt"],"description":"A break-glass support grant."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out or step-up required (code STEP_UP_REQUIRED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Not a firm admin.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"The request is already decided (code CONFLICT).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/support/grants/{grantId}/deny":{"post":{"operationId":"denySupportGrant","summary":"Deny a support request","description":"A firm admin denies a pending request with an optional reason code. Requires support_access.approve with step-up. A request that is already decided answers 409 CONFLICT. Writes support_grant.denied.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Support grant id."},"required":true,"description":"Support grant id.","name":"grantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["customer_request","incident","technical_support","data_recovery","other"],"description":"Why support access is asked (code, never free text)."}},"description":"Deny a pending support request."}}}},"responses":{"200":{"description":"The denied grant.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Grant id."},"tenantId":{"type":"string","format":"uuid","description":"Tenant the grant is for."},"scope":{"type":"string","enum":["tenant_metadata","room_read"],"description":"What the grant allows: tenant metadata, or read access inside one named room."},"roomId":{"type":"string","nullable":true,"format":"uuid","description":"Room for scope room_read; null otherwise."},"includeInternal":{"type":"boolean","description":"Whether internal-marked nodes are covered."},"status":{"type":"string","enum":["pending","active","expired","denied","revoked"],"description":"Grant state at read time (expired is derived from expiresAt and the clock)."},"reasonCode":{"type":"string","enum":["customer_request","incident","technical_support","data_recovery","other"],"description":"Why support access is asked (code, never free text)."},"requestedDurationHours":{"type":"integer","nullable":true,"minimum":1,"maximum":24,"description":"Window the support principal asked for; null for rows that predate this field."},"requestedAt":{"type":"string","format":"date-time","description":"When the request was made."},"approvedAt":{"type":"string","nullable":true,"format":"date-time","description":"When a firm admin approved or denied it."},"startsAt":{"type":"string","nullable":true,"format":"date-time","description":"Start of the granted window."},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"End of the granted window."},"revokedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the firm revoked it."}},"required":["id","tenantId","scope","roomId","includeInternal","status","reasonCode","requestedDurationHours","requestedAt","approvedAt","startsAt","expiresAt","revokedAt"],"description":"A break-glass support grant."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out or step-up required (code STEP_UP_REQUIRED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Not a firm admin.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"The request is already decided (code CONFLICT).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/support/grants/{grantId}/revoke":{"post":{"operationId":"revokeSupportGrant","summary":"Revoke an active support grant","description":"A firm admin stops an approved grant immediately. Requires support_access.revoke (no step-up). A grant that is not active (pending, denied or already revoked) answers 409 CONFLICT. Writes support_grant.revoked.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Support grant id."},"required":true,"description":"Support grant id.","name":"grantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["customer_request","incident","technical_support","data_recovery","other"],"description":"Why support access is asked (code, never free text)."}},"description":"Revoke an approved support grant."}}}},"responses":{"200":{"description":"The revoked grant.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Grant id."},"tenantId":{"type":"string","format":"uuid","description":"Tenant the grant is for."},"scope":{"type":"string","enum":["tenant_metadata","room_read"],"description":"What the grant allows: tenant metadata, or read access inside one named room."},"roomId":{"type":"string","nullable":true,"format":"uuid","description":"Room for scope room_read; null otherwise."},"includeInternal":{"type":"boolean","description":"Whether internal-marked nodes are covered."},"status":{"type":"string","enum":["pending","active","expired","denied","revoked"],"description":"Grant state at read time (expired is derived from expiresAt and the clock)."},"reasonCode":{"type":"string","enum":["customer_request","incident","technical_support","data_recovery","other"],"description":"Why support access is asked (code, never free text)."},"requestedDurationHours":{"type":"integer","nullable":true,"minimum":1,"maximum":24,"description":"Window the support principal asked for; null for rows that predate this field."},"requestedAt":{"type":"string","format":"date-time","description":"When the request was made."},"approvedAt":{"type":"string","nullable":true,"format":"date-time","description":"When a firm admin approved or denied it."},"startsAt":{"type":"string","nullable":true,"format":"date-time","description":"Start of the granted window."},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"End of the granted window."},"revokedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the firm revoked it."}},"required":["id","tenantId","scope","roomId","includeInternal","status","reasonCode","requestedDurationHours","requestedAt","approvedAt","startsAt","expiresAt","revokedAt"],"description":"A break-glass support grant."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Not a firm admin.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"The grant is not active (code CONFLICT).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/audit-reports/{reportId}/download":{"get":{"operationId":"downloadAuditReport","summary":"Download an audit report CSV","description":"Downloads the stored CSV (AUD-03, T-260914-97dc). Requires audit.export.download (firm_admin/compliance with step-up). The x-ddr-report-sha256 header carries the SHA-256 of the exact bytes. Unknown or expired (>7 days) ids answer 404.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Stored audit report id."},"required":true,"description":"Stored audit report id.","name":"reportId","in":"path"}],"responses":{"200":{"description":"CSV export with the x-ddr-report-sha256 integrity header.","content":{"text/csv":{"schema":{"type":"string","description":"Audit report CSV (UTF-8 with BOM)."}}}},"400":{"description":"Invalid request.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (audit.export.download requires firm_admin/compliance with step-up).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown or expired report, or no access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"AUDIT_UNAVAILABLE: the audit event could not be written; nothing was served (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/flows/{flowId}/checklist":{"get":{"operationId":"getUploadRequestChecklist","summary":"Checklist view of one request","description":"Client-facing checklist of a request (INT-02): every visible item id with its engine item status plus the requested/delivered/missing buckets and a request summary (deadline, status, progress). `delivered` is the reference `DONE_FOR_CLIENT` set (submitted/in_review/approved/not_applicable) and `missing` the required `OPEN_FOR_CLIENT` items (to_do/rejected), so a rejected item is missing and needs attention, not delivered. Only sent, completed and closed requests are returned: a draft request answers 404. Returns ids, statuses, counts and the request title only; instructions rows are excluded and a guest gets 404 on every request not addressed to it (PERM-02). Navigation read: no audit event.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Request (flow) id; the client portal calls a flow a \"request\"."},"required":true,"description":"Request (flow) id; the client portal calls a flow a \"request\".","name":"flowId","in":"path"}],"responses":{"200":{"description":"Checklist of the request.","content":{"application/json":{"schema":{"type":"object","properties":{"request":{"type":"object","properties":{"requestId":{"type":"string","nullable":true,"format":"uuid","description":"The request behind the link, or null for a room invitation link (ADR-0026)."},"title":{"type":"string","minLength":1,"maxLength":200,"description":"Request title shown to the client (the `createFlowBody.title` bound)."},"dueDate":{"type":"string","nullable":true,"format":"date-time","description":"Absolute due date, or null when there is none."},"status":{"type":"string","enum":["sent","completed","closed"],"description":"Client-visible flow status (`sent`/`completed`/`closed`); a draft request answers 404."},"overdue":{"type":"boolean","description":"True when the due date has passed while a required item is still missing."},"progress":{"type":"object","properties":{"done":{"type":"integer","minimum":0,"description":"Items counted as done for this viewer."},"total":{"type":"integer","minimum":0,"description":"Visible items that count for progress."}},"required":["done","total"],"description":"Progress counters for this viewer (INT-F18)."}},"required":["requestId","title","dueDate","status","overdue","progress"],"additionalProperties":false,"description":"Client-visible request summary."},"requested":{"type":"array","items":{"type":"string","format":"uuid"},"description":"All visible item ids (the full checklist)."},"delivered":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Visible item ids whose engine status is submitted, in_review, approved or not_applicable."},"missing":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Required visible item ids whose engine status is to_do or rejected (needs attention)."},"counts":{"type":"object","properties":{"requested":{"type":"integer","minimum":0},"delivered":{"type":"integer","minimum":0},"missing":{"type":"integer","minimum":0}},"required":["requested","delivered","missing"],"description":"Counts of the three buckets."}},"required":["request","requested","delivered","missing","counts"],"additionalProperties":false,"description":"Checklist view of one request (requested / delivered / missing)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or request, or no access (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/guest-links":{"post":{"operationId":"createGuestLink","summary":"Create an invitation link for a request recipient","description":"Creates one guest invitation link (ADR-0003 D6): 32 random bytes, base64url, stored as SHA-256, valid 14 days by default (firm setting 1-30). Requires manage on the room and the request; a guest gets 404. The raw token and its /g/{token} URL are returned exactly once and are never logged (ADR-0006 D3).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the room."},"required":true,"description":"Tenant that owns the room.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room the invitation belongs to."},"required":true,"description":"Room the invitation belongs to.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","nullable":true,"format":"uuid","description":"The request behind the link, or null for a room invitation link (ADR-0026)."},"email":{"type":"string","maxLength":254,"format":"email","description":"Invited e-mail address; the code always goes here."},"slotLabel":{"type":"string","minLength":1,"maxLength":80,"description":"Optional recipient label (slot label); never a client name."},"expiresInDays":{"type":"integer","minimum":1,"maximum":30,"description":"Link lifetime in days (1-30); defaults to 14 (ADR-0003 D6)."}},"required":["requestId","email"],"additionalProperties":false,"description":"Create one invitation link for a request recipient."}}}},"responses":{"201":{"description":"Link created; the one-time URL is in this response only.","content":{"application/json":{"schema":{"type":"object","properties":{"link":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Invitation link id."},"roomId":{"type":"string","format":"uuid","description":"Room the invitation belongs to."},"requestId":{"type":"string","nullable":true,"format":"uuid","description":"The request behind the link, or null for a room invitation link (ADR-0026)."},"emailHint":{"type":"string","minLength":3,"maxLength":120,"description":"Masked invited e-mail address (never the full address)."},"slotLabel":{"type":"string","nullable":true,"minLength":1,"maxLength":80,"description":"Recipient label shown to the firm (\"Applicant 1\"); never a client name."},"state":{"type":"string","enum":["active","revoked","expired"],"description":"Invitation link state (ADR-0003 D6)."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp (UTC, ISO-8601)."},"expiresAt":{"type":"string","format":"date-time","description":"Expiry timestamp (UTC, ISO-8601)."},"lastUsedAt":{"type":"string","nullable":true,"format":"date-time","description":"Last successful code sign-in, or null when never used."},"useCount":{"type":"integer","minimum":0,"description":"Successful sign-ins through this link."}},"required":["id","roomId","requestId","emailHint","slotLabel","state","createdAt","expiresAt","lastUsedAt","useCount"],"description":"One guest invitation link (token omitted)."},"url":{"type":"string","pattern":"^https?:\\/\\/[^\\s]+\\/g\\/[A-Za-z0-9_-]{43}$","description":"Absolute https invitation URL with the one-time token; returned exactly once."}},"required":["link","url"],"description":"Created guest link with its one-time invitation URL."}}}},"400":{"description":"Invalid body (e-mail or lifetime).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: no manage on the room or request.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or request (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"422":{"description":"The recipient cannot be invited (closed request, invalid slot).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"get":{"operationId":"listGuestLinks","summary":"List invitation links of a room","description":"Lists the invitation links of a room with their state, expiry and use count (INT-01). Tokens are never returned, and the invited address is masked (CLAUDE.md rule 1). Requires manage on the room; a guest gets 404. Navigation read: no audit event.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the room."},"required":true,"description":"Tenant that owns the room.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room the invitation belongs to."},"required":true,"description":"Room the invitation belongs to.","name":"roomId","in":"path"}],"responses":{"200":{"description":"Invitation links of the room.","content":{"application/json":{"schema":{"type":"object","properties":{"links":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Invitation link id."},"roomId":{"type":"string","format":"uuid","description":"Room the invitation belongs to."},"requestId":{"type":"string","nullable":true,"format":"uuid","description":"The request behind the link, or null for a room invitation link (ADR-0026)."},"emailHint":{"type":"string","minLength":3,"maxLength":120,"description":"Masked invited e-mail address (never the full address)."},"slotLabel":{"type":"string","nullable":true,"minLength":1,"maxLength":80,"description":"Recipient label shown to the firm (\"Applicant 1\"); never a client name."},"state":{"type":"string","enum":["active","revoked","expired"],"description":"Invitation link state (ADR-0003 D6)."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp (UTC, ISO-8601)."},"expiresAt":{"type":"string","format":"date-time","description":"Expiry timestamp (UTC, ISO-8601)."},"lastUsedAt":{"type":"string","nullable":true,"format":"date-time","description":"Last successful code sign-in, or null when never used."},"useCount":{"type":"integer","minimum":0,"description":"Successful sign-ins through this link."}},"required":["id","roomId","requestId","emailHint","slotLabel","state","createdAt","expiresAt","lastUsedAt","useCount"],"description":"One guest invitation link (token omitted)."},"description":"Invitation links of the room (tokens omitted)."}},"required":["links"],"description":"Invitation links of one room."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: no manage on the room.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/guest-links/{linkId}":{"delete":{"operationId":"revokeGuestLink","summary":"Revoke an invitation link","description":"Revokes an invitation link; the token stops working immediately and an in-flight code challenge for it is dead. Requires manage on the room. A guest gets 404.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the room."},"required":true,"description":"Tenant that owns the room.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room the invitation belongs to."},"required":true,"description":"Room the invitation belongs to.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Invitation link id."},"required":true,"description":"Invitation link id.","name":"linkId","in":"path"}],"responses":{"204":{"description":"Revoked."},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: no manage on the room.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or link (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"The link is already revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/guest-links/{token}/code":{"post":{"operationId":"requestGuestCode","summary":"Send the guest e-mail code","description":"Public. Queues the 6-digit e-mail code to the address the firm invited (never an address typed here), 10 minutes valid, single use (ADR-0003 D6). Always answers the same 202 body with the same timing, whether or not the link exists, so it is no existence oracle. Per-IP and per-identity rate limits; codes per identity are capped per ADR-0003 D6. Never returns or logs the code; the e-mail names the firm and the code only. Until T-260914-63df registers the route, an unmatched request answers the framework 404; the implemented endpoint never answers 404 for link existence.","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Invitation token (32 random bytes, base64url). Treat as a secret."},"required":true,"description":"Invitation token (32 random bytes, base64url). Treat as a secret.","name":"token","in":"path"}],"responses":{"202":{"description":"Code queued, if the link is valid (uniform answer).","content":{"application/json":{"schema":{"type":"object","properties":{"sent":{"type":"boolean","enum":[true],"description":"A code was queued to the invited address, if the link is valid."}},"required":["sent"],"description":"Uniform answer of the \"send me a code\" endpoint (no existence oracle)."}}}},"400":{"description":"Invalid link token.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Route not yet registered (T-260914-63df) or unknown path; the implemented endpoint answers the uniform 202 instead of revealing link existence.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/guest-links/{token}/session":{"post":{"operationId":"signInWithGuestCode","summary":"Sign in a guest with an e-mail code","description":"Public. Verifies the 6-digit code of the invitation link and creates the guest session (ADR-0003 §2C/D6): codes are single use, 10 minutes valid, at most 5 wrong attempts, then the challenge is dead. The effective strength and the per-tenant SMS second factor (HYP-02) are in the response; a room that needs it must complete it before any room content. Writes auth.guest_code_verified or auth.guest_code_failed. No room content is returned here.","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Invitation token (32 random bytes, base64url). Treat as a secret."},"required":true,"description":"Invitation token (32 random bytes, base64url). Treat as a secret.","name":"token","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","pattern":"^\\d{6}$","description":"6-digit e-mail code; single use and short lived (ADR-0003 D6)."},"returnTo":{"type":"string","minLength":1,"maxLength":2048,"description":"In-app path to return to after sign-in; same-origin only."}},"required":["code"],"additionalProperties":false,"description":"Sign in with the e-mail code of an invitation link."}}}},"responses":{"200":{"description":"Guest session created.","content":{"application/json":{"schema":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid","description":"Tenant the guest entered."},"roomId":{"type":"string","format":"uuid","description":"Room the invitation belongs to."},"requestId":{"type":"string","nullable":true,"format":"uuid","description":"The request behind the link, or null for a room invitation link (ADR-0026)."},"authStrength":{"type":"string","enum":["single","mfa"],"description":"Effective strength for this tenant (ADR-0003 D7)."},"requiresSmsSecondFactor":{"type":"boolean","description":"True when the room mode needs the per-tenant SMS code before room content (HYP-02)."},"idleTimeoutSeconds":{"type":"integer","minimum":60,"description":"Idle timeout of the guest session."},"absoluteExpiresAt":{"type":"string","format":"date-time","description":"Absolute session expiry (UTC, ISO-8601)."},"freeBranding":{"type":"boolean"}},"required":["tenantId","roomId","requestId","authStrength","requiresSmsSecondFactor","idleTimeoutSeconds","absoluteExpiresAt"],"description":"Guest session created from an invitation code."}}}},"400":{"description":"Invalid body (not a 6-digit code) or malformed token.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Wrong, reused, expired or too many attempts (uniform answer).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown or revoked invitation link.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/me/notification-preferences":{"get":{"operationId":"getNotificationPreferences","summary":"Read my notification preferences","description":"Per-principal e-mail preferences (INT-05/INT-06): e-mail frequency (immediately, daily, weekly, never), upload notifications, request updates and deadline reminders. Own data only; 404 on tenant mismatch. Not audited.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"My preferences.","content":{"application/json":{"schema":{"type":"object","properties":{"emailFrequency":{"type":"string","enum":["immediately","daily","weekly","never"],"description":"E-mail notification frequency per principal (INT-05)."},"uploadNotifications":{"type":"boolean","description":"Notify on a new upload, also while the professional is online (INT-06)."},"requestUpdates":{"type":"boolean","description":"Notify when a client submits an item or answers a question (counts only)."},"deadlineReminders":{"type":"boolean","description":"Remind me and the client before a request deadline (INT-03)."}},"required":["emailFrequency","uploadNotifications","requestUpdates","deadlineReminders"],"additionalProperties":false,"description":"Notification preferences of one principal; e-mails never carry content."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"put":{"operationId":"putNotificationPreferences","summary":"Replace my notification preferences","description":"Full replace of my e-mail preferences (strict: closed frequency enum, unknown keys rejected). E-mails always name the firm and a count only, never item titles, file names or client names (INT-05, D10). Not audited.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"emailFrequency":{"type":"string","enum":["immediately","daily","weekly","never"],"description":"E-mail notification frequency per principal (INT-05)."},"uploadNotifications":{"type":"boolean","description":"Notify on a new upload, also while the professional is online (INT-06)."},"requestUpdates":{"type":"boolean","description":"Notify when a client submits an item or answers a question (counts only)."},"deadlineReminders":{"type":"boolean","description":"Remind me and the client before a request deadline (INT-03)."}},"required":["emailFrequency","uploadNotifications","requestUpdates","deadlineReminders"],"additionalProperties":false,"description":"Replace my notification preferences (full document; unknown keys are rejected)."}}}},"responses":{"200":{"description":"Stored preferences.","content":{"application/json":{"schema":{"type":"object","properties":{"emailFrequency":{"type":"string","enum":["immediately","daily","weekly","never"],"description":"E-mail notification frequency per principal (INT-05)."},"uploadNotifications":{"type":"boolean","description":"Notify on a new upload, also while the professional is online (INT-06)."},"requestUpdates":{"type":"boolean","description":"Notify when a client submits an item or answers a question (counts only)."},"deadlineReminders":{"type":"boolean","description":"Remind me and the client before a request deadline (INT-03)."}},"required":["emailFrequency","uploadNotifications","requestUpdates","deadlineReminders"],"additionalProperties":false,"description":"Notification preferences of one principal; e-mails never carry content."}}}},"400":{"description":"Invalid request.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/invitations/users":{"post":{"operationId":"createUserInvitation","summary":"Invite a colleague onto a firm role","description":"Creates one colleague invitation (ADR-0021 §1, ADR-0029 D1; ORG-04): the address, an optional name, the language and the firm role granted at the first sign-in. Queues the invitation e-mail with a single-use link (`/invite/{tenantId}/{token}`, 32 random bytes, stored as SHA-256 only, never returned). No Keycloak user is created here: that happens when the colleague opens the link and continues (ADR-0003 D8). An address that already belongs to a user of this firm or has a live invitation answers 409 CONFLICT. Firm admins only (`user.manage`). Writes principal.invited (ADR-0006 D4; ids and the role code only, never the address).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"format":"email","description":"Invited e-mail address; the invitation e-mail goes here."},"name":{"type":"string","minLength":1,"maxLength":200,"description":"Colleague's name for the invitation."},"language":{"type":"string","enum":["nl","en"],"description":"Invitation language (ORG-06); default nl."},"role":{"type":"string","enum":["firm_admin","lawyer","legal_assistant","secretary","billing","adviser","back_office","compliance"],"description":"Firm role granted when the colleague first signs in (ADR-0005 §3)."},"expiresInDays":{"type":"integer","minimum":1,"maximum":30,"description":"Invitation link lifetime in days (1-30); defaults to 14 (ADR-0003 D6)."}},"required":["email","role"],"additionalProperties":false,"description":"Invite one colleague onto a firm role."}}}},"responses":{"201":{"description":"Created and sent.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Invitation id."},"kind":{"type":"string","enum":["user","guest"],"description":"Invitation target: an internal firm user or an external guest (ADR-0005 §4)."},"status":{"type":"string","enum":["pending","accepted","revoked","expired"],"description":"Invitation status; `expired` is derived from `expiresAt`."},"language":{"type":"string","enum":["nl","en"],"description":"Invitation language (ORG-06; FR/DE later)."},"email":{"type":"string","maxLength":254,"format":"email","description":"Invited address (firm-authorized read; never logged, never in audit payloads)."},"name":{"type":"string","nullable":true,"minLength":1,"maxLength":200,"description":"Invited person's name when known; null otherwise."},"role":{"type":"string","nullable":true,"enum":["firm_admin","lawyer","legal_assistant","secretary","billing","adviser","back_office","compliance",null],"description":"Firm role for a user invitation; null for a guest invitation."},"roomId":{"type":"string","nullable":true,"format":"uuid","description":"Room a guest invitation grants access to; null for a user invitation."},"groupIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":50,"description":"External groups the guest joins; empty for a user invitation."},"accessEndsAt":{"type":"string","nullable":true,"format":"date-time","description":"Access end date (PERM-09) or null; guests only."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp (UTC, ISO-8601)."},"expiresAt":{"type":"string","format":"date-time","description":"Token expiry (UTC, ISO-8601)."},"lastSentAt":{"type":"string","format":"date-time","description":"When the invitation was (re)sent last."},"delivery":{"type":"object","properties":{"status":{"type":"string","enum":["queued","sending","sent","failed","unknown"],"default":"unknown","description":"Outbox state of the latest invitation e-mail: queued (waiting), sending (being delivered), sent (accepted by the mail server), failed (the platform could not send it) or unknown (no record). Not a read receipt."},"attempts":{"type":"integer","minimum":0,"default":0,"description":"Send attempts the platform made for the latest e-mail."}},"default":{"status":"unknown","attempts":0},"description":"Delivery state of the latest invitation e-mail (support diagnosis, never content)."},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"Acceptance time, or null."},"revokedAt":{"type":"string","nullable":true,"format":"date-time","description":"Revocation time, or null."}},"required":["id","kind","status","language","email","name","role","roomId","groupIds","accessEndsAt","createdAt","expiresAt","lastSentAt","acceptedAt","revokedAt"],"additionalProperties":false,"description":"One invitation (firm-side view)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `user.manage`).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant; no existence leak, PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"CONFLICT: the address is already a user of this firm or has a live invitation","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"get":{"operationId":"listUserInvitations","summary":"List the colleague invitations of the firm","description":"Colleague invitations newest first with role and lifecycle (ADR-0021 §1). A pending invitation past its expiry is reported as expired (ADR-0003 D6). Firm admins only (`user.manage`); 404 hides existence (including cross-tenant, PERM-02). Reads the address, never logs it. Navigation read: no audit event. Each row carries `delivery`: the outbox state of its latest e-mail (queued, sending, sent, failed or unknown) with the attempt count, so a report of a missing invitation can be diagnosed. A status word and a count only; never the message, its subject or a bounce reason, and never a read receipt.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","enum":["pending","accepted","revoked","expired"],"description":"Invitation status; `expired` is derived from `expiresAt`."},"required":false,"description":"Invitation status; `expired` is derived from `expiresAt`.","name":"status","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":100,"description":"Substring match over the invited address or name."},"required":false,"description":"Substring match over the invited address or name.","name":"search","in":"query"}],"responses":{"200":{"description":"Colleague invitations of the firm, newest first with an explicit truncated signal.","content":{"application/json":{"schema":{"type":"object","properties":{"invitations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Invitation id."},"kind":{"type":"string","enum":["user","guest"],"description":"Invitation target: an internal firm user or an external guest (ADR-0005 §4)."},"status":{"type":"string","enum":["pending","accepted","revoked","expired"],"description":"Invitation status; `expired` is derived from `expiresAt`."},"language":{"type":"string","enum":["nl","en"],"description":"Invitation language (ORG-06; FR/DE later)."},"email":{"type":"string","maxLength":254,"format":"email","description":"Invited address (firm-authorized read; never logged, never in audit payloads)."},"name":{"type":"string","nullable":true,"minLength":1,"maxLength":200,"description":"Invited person's name when known; null otherwise."},"role":{"type":"string","nullable":true,"enum":["firm_admin","lawyer","legal_assistant","secretary","billing","adviser","back_office","compliance",null],"description":"Firm role for a user invitation; null for a guest invitation."},"roomId":{"type":"string","nullable":true,"format":"uuid","description":"Room a guest invitation grants access to; null for a user invitation."},"groupIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":50,"description":"External groups the guest joins; empty for a user invitation."},"accessEndsAt":{"type":"string","nullable":true,"format":"date-time","description":"Access end date (PERM-09) or null; guests only."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp (UTC, ISO-8601)."},"expiresAt":{"type":"string","format":"date-time","description":"Token expiry (UTC, ISO-8601)."},"lastSentAt":{"type":"string","format":"date-time","description":"When the invitation was (re)sent last."},"delivery":{"type":"object","properties":{"status":{"type":"string","enum":["queued","sending","sent","failed","unknown"],"default":"unknown","description":"Outbox state of the latest invitation e-mail: queued (waiting), sending (being delivered), sent (accepted by the mail server), failed (the platform could not send it) or unknown (no record). Not a read receipt."},"attempts":{"type":"integer","minimum":0,"default":0,"description":"Send attempts the platform made for the latest e-mail."}},"default":{"status":"unknown","attempts":0},"description":"Delivery state of the latest invitation e-mail (support diagnosis, never content)."},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"Acceptance time, or null."},"revokedAt":{"type":"string","nullable":true,"format":"date-time","description":"Revocation time, or null."}},"required":["id","kind","status","language","email","name","role","roomId","groupIds","accessEndsAt","createdAt","expiresAt","lastSentAt","acceptedAt","revokedAt"],"additionalProperties":false,"description":"One invitation (firm-side view)."},"description":"Colleague invitations of the firm, newest first."},"truncated":{"type":"boolean","description":"True when more invitations matched than were returned (the list is partial)."}},"required":["invitations","truncated"],"description":"Colleague invitations with an explicit completeness signal."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `user.manage`).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant; no existence leak, PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/invitations/bulk":{"post":{"operationId":"createInvitationsBulk","summary":"Bulk invite from pasted addresses or CSV","description":"Bulk invite (PERM-13): the UI parses pasted addresses or a CSV into rows; every row is validated individually and a valid batch answers 200 with a per-row report and partial success. A malformed address, a duplicate row, an existing member or a missing room/group becomes a per-row code, never a whole-batch 400. More than INVITATION_MAX_BULK_ROWS rows or a missing batch target answer 400. Guests are free and unlimited (ORG-09). Writes principal.invited per created row.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["user","guest"],"description":"Invitation target: an internal firm user or an external guest (ADR-0005 §4)."},"role":{"type":"string","enum":["firm_admin","lawyer","legal_assistant","secretary","billing","adviser","back_office","compliance"],"description":"Firm role: required for kind user."},"roomId":{"type":"string","format":"uuid","description":"Room: required for kind guest."},"groupIds":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"maxItems":50,"description":"External groups the whole guest batch joins."},"language":{"type":"string","enum":["nl","en"],"description":"Invitation language (ORG-06; FR/DE later)."},"expiresInDays":{"type":"integer","minimum":1,"maximum":30},"rows":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","minLength":1,"maxLength":254,"description":"Pasted or CSV address; validated per row, so one bad row never fails the batch."},"name":{"type":"string","minLength":1,"maxLength":200,"description":"Optional name for this row."}},"required":["email"],"additionalProperties":false,"description":"One row of a bulk invitation call."},"minItems":1,"maxItems":500,"description":"Between 1 and 500 rows."}},"required":["kind","rows"],"additionalProperties":false,"description":"Bulk invite: rows validated individually, partial success is normal."}}}},"responses":{"200":{"description":"Per-row report with partial success.","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","minimum":0,"description":"Row index in the request body."},"email":{"type":"string","maxLength":254,"description":"The address as sent (echo only, never logged)."},"outcome":{"type":"string","enum":["created","skipped","invalid"],"description":"Bulk row outcome: created, skipped (valid but not sent) or invalid."},"invitationId":{"type":"string","nullable":true,"format":"uuid","description":"Created invitation id, or null."},"error":{"type":"string","nullable":true,"enum":["invalid_email","duplicate_row","already_invited","already_member","group_not_found","group_internal","room_not_found","guest_limit",null],"description":"Reason for a skipped/invalid row, or null."}},"required":["index","email","outcome","invitationId","error"],"description":"One row of the bulk report."},"description":"Per-row report, in request order."},"summary":{"type":"object","properties":{"total":{"type":"integer","minimum":0},"created":{"type":"integer","minimum":0},"skipped":{"type":"integer","minimum":0},"invalid":{"type":"integer","minimum":0}},"required":["total","created","skipped","invalid"],"description":"Bulk outcome counts; total equals created + skipped + invalid."},"partialSuccess":{"type":"boolean","description":"True when at least one row was created and at least one row was not."}},"required":["results","summary","partialSuccess"],"description":"Bulk report: per-row outcomes with partial success."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `user.manage`, or no room access administration for a guest batch).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant; no existence leak, PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/invitations/users/{invitationId}/resend":{"post":{"operationId":"resendUserInvitation","summary":"Resend a colleague invitation with a fresh link","description":"Rotates the single-use token (the previous link stops working), extends the expiry and queues the invitation e-mail again (ADR-0003 D8). Only a pending or expired invitation; an accepted or revoked one answers 409 INVITATION_NOT_PENDING. A guest invitation id or an id of another tenant answers 404 (ADR-0021 §4). Firm admins only (`user.manage`). Writes principal.invited. Every invitation carries `delivery`: the outbox state of its latest e-mail (queued, sending, sent, failed or unknown) with the attempt count, so \"no e-mail arrived\" can be diagnosed without a read receipt and without exposing the message. A resend points at its own outbox row, so the state is the latest attempt.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Invitation id."},"required":true,"description":"Invitation id.","name":"invitationId","in":"path"}],"responses":{"200":{"description":"Resent with a fresh token.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Invitation id."},"kind":{"type":"string","enum":["user","guest"],"description":"Invitation target: an internal firm user or an external guest (ADR-0005 §4)."},"status":{"type":"string","enum":["pending","accepted","revoked","expired"],"description":"Invitation status; `expired` is derived from `expiresAt`."},"language":{"type":"string","enum":["nl","en"],"description":"Invitation language (ORG-06; FR/DE later)."},"email":{"type":"string","maxLength":254,"format":"email","description":"Invited address (firm-authorized read; never logged, never in audit payloads)."},"name":{"type":"string","nullable":true,"minLength":1,"maxLength":200,"description":"Invited person's name when known; null otherwise."},"role":{"type":"string","nullable":true,"enum":["firm_admin","lawyer","legal_assistant","secretary","billing","adviser","back_office","compliance",null],"description":"Firm role for a user invitation; null for a guest invitation."},"roomId":{"type":"string","nullable":true,"format":"uuid","description":"Room a guest invitation grants access to; null for a user invitation."},"groupIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":50,"description":"External groups the guest joins; empty for a user invitation."},"accessEndsAt":{"type":"string","nullable":true,"format":"date-time","description":"Access end date (PERM-09) or null; guests only."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp (UTC, ISO-8601)."},"expiresAt":{"type":"string","format":"date-time","description":"Token expiry (UTC, ISO-8601)."},"lastSentAt":{"type":"string","format":"date-time","description":"When the invitation was (re)sent last."},"delivery":{"type":"object","properties":{"status":{"type":"string","enum":["queued","sending","sent","failed","unknown"],"default":"unknown","description":"Outbox state of the latest invitation e-mail: queued (waiting), sending (being delivered), sent (accepted by the mail server), failed (the platform could not send it) or unknown (no record). Not a read receipt."},"attempts":{"type":"integer","minimum":0,"default":0,"description":"Send attempts the platform made for the latest e-mail."}},"default":{"status":"unknown","attempts":0},"description":"Delivery state of the latest invitation e-mail (support diagnosis, never content)."},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"Acceptance time, or null."},"revokedAt":{"type":"string","nullable":true,"format":"date-time","description":"Revocation time, or null."}},"required":["id","kind","status","language","email","name","role","roomId","groupIds","accessEndsAt","createdAt","expiresAt","lastSentAt","acceptedAt","revokedAt"],"additionalProperties":false,"description":"One invitation (firm-side view)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `user.manage`).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant; no existence leak, PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"INVITATION_NOT_PENDING: the invitation was already accepted or revoked","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/invitations/users/{invitationId}/revoke":{"post":{"operationId":"revokeUserInvitation","summary":"Revoke a colleague invitation","description":"Invalidates the link immediately so it can never be continued or bound (ADR-0003 D8). Only a pending or expired invitation; an accepted one answers 409 INVITATION_NOT_PENDING (block the user instead). A Keycloak user the invitation already prepared is left untouched (no identity-wide change, ADR-0003 D3a) and gains no access. A guest invitation id or an id of another tenant answers 404. Firm admins only (`user.manage`). Writes principal.invitation_revoked.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Invitation id."},"required":true,"description":"Invitation id.","name":"invitationId","in":"path"}],"responses":{"200":{"description":"Revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Invitation id."},"kind":{"type":"string","enum":["user","guest"],"description":"Invitation target: an internal firm user or an external guest (ADR-0005 §4)."},"status":{"type":"string","enum":["pending","accepted","revoked","expired"],"description":"Invitation status; `expired` is derived from `expiresAt`."},"language":{"type":"string","enum":["nl","en"],"description":"Invitation language (ORG-06; FR/DE later)."},"email":{"type":"string","maxLength":254,"format":"email","description":"Invited address (firm-authorized read; never logged, never in audit payloads)."},"name":{"type":"string","nullable":true,"minLength":1,"maxLength":200,"description":"Invited person's name when known; null otherwise."},"role":{"type":"string","nullable":true,"enum":["firm_admin","lawyer","legal_assistant","secretary","billing","adviser","back_office","compliance",null],"description":"Firm role for a user invitation; null for a guest invitation."},"roomId":{"type":"string","nullable":true,"format":"uuid","description":"Room a guest invitation grants access to; null for a user invitation."},"groupIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":50,"description":"External groups the guest joins; empty for a user invitation."},"accessEndsAt":{"type":"string","nullable":true,"format":"date-time","description":"Access end date (PERM-09) or null; guests only."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp (UTC, ISO-8601)."},"expiresAt":{"type":"string","format":"date-time","description":"Token expiry (UTC, ISO-8601)."},"lastSentAt":{"type":"string","format":"date-time","description":"When the invitation was (re)sent last."},"delivery":{"type":"object","properties":{"status":{"type":"string","enum":["queued","sending","sent","failed","unknown"],"default":"unknown","description":"Outbox state of the latest invitation e-mail: queued (waiting), sending (being delivered), sent (accepted by the mail server), failed (the platform could not send it) or unknown (no record). Not a read receipt."},"attempts":{"type":"integer","minimum":0,"default":0,"description":"Send attempts the platform made for the latest e-mail."}},"default":{"status":"unknown","attempts":0},"description":"Delivery state of the latest invitation e-mail (support diagnosis, never content)."},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"Acceptance time, or null."},"revokedAt":{"type":"string","nullable":true,"format":"date-time","description":"Revocation time, or null."}},"required":["id","kind","status","language","email","name","role","roomId","groupIds","accessEndsAt","createdAt","expiresAt","lastSentAt","acceptedAt","revokedAt"],"additionalProperties":false,"description":"One invitation (firm-side view)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `user.manage`).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant; no existence leak, PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"INVITATION_NOT_PENDING: the invitation was already accepted","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/invitation-links/{token}":{"get":{"operationId":"getUserInvitationLink","summary":"Read a colleague invitation by its link (public landing)","description":"Public landing data for the holder of a colleague invitation link (ADR-0029 D2, S-AUTH-04, S-MAIL-01): the firm name, the inviter name, a masked invited address, the language and the next step. The token is the only credential and is not a session, so this operation needs no negative authorization test. An expired, accepted or revoked invitation answers 200 with that status and a null nextStep; an unknown token or tenant answers 404. Names nothing but the firm and the inviter.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Invitation token (32 random bytes, base64url). Treat as a secret."},"required":true,"description":"Invitation token (32 random bytes, base64url). Treat as a secret.","name":"token","in":"path"}],"responses":{"200":{"description":"Public invitation landing data.","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["user","guest"],"description":"Invitation target: an internal firm user or an external guest (ADR-0005 §4)."},"status":{"type":"string","enum":["pending","accepted","revoked","expired"],"description":"Invitation status; `expired` is derived from `expiresAt`."},"language":{"type":"string","enum":["nl","en"],"description":"Invitation language (ORG-06; FR/DE later)."},"firmName":{"type":"string","minLength":1,"maxLength":200,"description":"Firm the invitation belongs to."},"inviterName":{"type":"string","nullable":true,"minLength":1,"maxLength":200,"description":"Inviting person's display name, or null."},"recipientEmailHint":{"type":"string","minLength":3,"maxLength":254,"description":"Masked invited address (j***@example.org); never the full address on a public read."},"recipientName":{"type":"string","nullable":true,"minLength":1,"maxLength":200,"description":"Known invited name, or null."},"nextStep":{"type":"string","nullable":true,"enum":["register","mfa","terms","done",null],"description":"Step the UI renders; null when the invitation is expired, accepted or revoked."},"termsRequired":{"type":"boolean","description":"True when the room terms still need accepting (ORG-07 hook, room-terms.ts)."},"expiresAt":{"type":"string","format":"date-time","description":"Token expiry (UTC, ISO-8601)."}},"required":["kind","status","language","firmName","inviterName","recipientEmailHint","recipientName","nextStep","termsRequired","expiresAt"],"additionalProperties":false,"description":"Public invitation landing data; masked address, no room or content names."}}}},"404":{"description":"Unknown link (code NOT_FOUND).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/invitation-links/{token}/continue":{"post":{"operationId":"continueUserInvitation","summary":"Continue a colleague invitation: prepare the sign-in identity","description":"ADR-0003 D8, ADR-0029 D2: the holder of a live colleague invitation link continues. Without a Keycloak user for the invited address the API commits an identity_admin_intent row, creates the user (verified address, enabled, the invitation language, required actions UPDATE_PASSWORD and CONFIGURE_TOTP, no credentials) and asks Keycloak to send its 'set up your sign-in' e-mail (execute-actions-email, client ddr-app, 30 minutes, back to the sign-in callback); the answer is `check_email`. A user the same invitation prepared earlier only gets that e-mail again. An existing, enabled user of another firm is never modified; the answer is `sign_in`. A disabled existing user answers 409 CONFLICT (the platform identity procedure applies, ADR-0003 D3a). In every case the response sets a short-lived HttpOnly cookie that lets the next sign-in in this browser bind the invitation: the binding itself happens only during that sign-in, when the ID token's verified address matches the invited one (ADR-0003 D8/D12.8). The token is the capability; this operation needs no negative authorization test. Writes no audit event (the binding writes principal.invitation_accepted).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Invitation token (32 random bytes, base64url). Treat as a secret."},"required":true,"description":"Invitation token (32 random bytes, base64url). Treat as a secret.","name":"token","in":"path"}],"responses":{"200":{"description":"Next step.","content":{"application/json":{"schema":{"type":"object","properties":{"next":{"type":"string","enum":["check_email","sign_in"],"description":"What the colleague does next: open the set-up e-mail, or sign in."}},"required":["next"],"additionalProperties":false,"description":"Next step of the colleague invitation."}}}},"404":{"description":"Unknown link (code NOT_FOUND).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"INVITATION_EXPIRED, INVITATION_ALREADY_ACCEPTED, INVITATION_REVOKED or CONFLICT: the invitation cannot be continued in its current state, or the identity is disabled","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"Identity administration unavailable (code INTERNAL); nothing was bound.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/invitations":{"post":{"operationId":"createRoomInvitation","summary":"Invite an external person into a room group","description":"Creates one guest invitation (ADR-0021 §2, ADR-0026): binds a code-based guest principal for the invited address and a membership of the one external group of this room (with the optional access end date), and queues the invitation e-mail with a single-use link (`/g/{token}`, stored hashed, never returned). The person signs in with an e-mail code sent to the invited address; the first sign-in accepts the invitation (ADR-0003 D8). An internal group, a group of another room or more than one group answers 400; an address that is already a member of this room or has a live invitation answers 409. Guests are free and unlimited (ORG-09). Writes principal.invited, room.membership_added.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"format":"email","description":"Invited e-mail address; the invitation e-mail and every code go here."},"name":{"type":"string","minLength":1,"maxLength":200,"description":"Invited person's name."},"language":{"type":"string","enum":["nl","en"],"description":"Invitation language (ORG-06); default nl."},"groupIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The one external group of this room the guest joins (MVP: one group per room)."},"accessEndsAt":{"type":"string","nullable":true,"format":"date-time","description":"Access end date (PERM-09) or null."},"expiresInDays":{"type":"integer","minimum":1,"maximum":30,"description":"Invitation link lifetime in days (1-30); defaults to 14 (ADR-0003 D6)."},"message":{"type":"string","minLength":1,"maxLength":2000,"description":"Optional personal message for the invitation e-mail."},"phone":{"type":"string","pattern":"^\\+[1-9]\\d{7,14}$","description":"Mobile number for the SMS second factor (ADR-0003 D7): without it the guest can sign in but not view room content."}},"required":["email","groupIds"],"additionalProperties":false,"description":"Invite one external person into one external group of the room."}}}},"responses":{"201":{"description":"Created and sent.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Invitation id."},"kind":{"type":"string","enum":["user","guest"],"description":"Invitation target: an internal firm user or an external guest (ADR-0005 §4)."},"status":{"type":"string","enum":["pending","accepted","revoked","expired"],"description":"Invitation status; `expired` is derived from `expiresAt`."},"language":{"type":"string","enum":["nl","en"],"description":"Invitation language (ORG-06; FR/DE later)."},"email":{"type":"string","maxLength":254,"format":"email","description":"Invited address (firm-authorized read; never logged, never in audit payloads)."},"name":{"type":"string","nullable":true,"minLength":1,"maxLength":200,"description":"Invited person's name when known; null otherwise."},"role":{"type":"string","nullable":true,"enum":["firm_admin","lawyer","legal_assistant","secretary","billing","adviser","back_office","compliance",null],"description":"Firm role for a user invitation; null for a guest invitation."},"roomId":{"type":"string","nullable":true,"format":"uuid","description":"Room a guest invitation grants access to; null for a user invitation."},"groupIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":50,"description":"External groups the guest joins; empty for a user invitation."},"accessEndsAt":{"type":"string","nullable":true,"format":"date-time","description":"Access end date (PERM-09) or null; guests only."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp (UTC, ISO-8601)."},"expiresAt":{"type":"string","format":"date-time","description":"Token expiry (UTC, ISO-8601)."},"lastSentAt":{"type":"string","format":"date-time","description":"When the invitation was (re)sent last."},"delivery":{"type":"object","properties":{"status":{"type":"string","enum":["queued","sending","sent","failed","unknown"],"default":"unknown","description":"Outbox state of the latest invitation e-mail: queued (waiting), sending (being delivered), sent (accepted by the mail server), failed (the platform could not send it) or unknown (no record). Not a read receipt."},"attempts":{"type":"integer","minimum":0,"default":0,"description":"Send attempts the platform made for the latest e-mail."}},"default":{"status":"unknown","attempts":0},"description":"Delivery state of the latest invitation e-mail (support diagnosis, never content)."},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"Acceptance time, or null."},"revokedAt":{"type":"string","nullable":true,"format":"date-time","description":"Revocation time, or null."}},"required":["id","kind","status","language","email","name","role","roomId","groupIds","accessEndsAt","createdAt","expiresAt","lastSentAt","acceptedAt","revokedAt"],"additionalProperties":false,"description":"One invitation (firm-side view)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no room access administration, `room.membership.manage`).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant; no existence leak, PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"CONFLICT: the address is already a member or has a live invitation","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"get":{"operationId":"listRoomInvitations","summary":"List the guest invitations of a room","description":"Guest invitations of the path room, newest first (ADR-0021 §2). A pending invitation past its expiry is reported as expired. Requires `room.membership.manage`; every other denial answers 404 (PERM-02). Navigation read: no audit event. Each row carries `delivery`: the outbox state of its latest e-mail (queued, sending, sent, failed or unknown) with the attempt count, so a report of a missing invitation can be diagnosed. A status word and a count only; never the message, its subject or a bounce reason, and never a read receipt.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","enum":["pending","accepted","revoked","expired"],"description":"Invitation status; `expired` is derived from `expiresAt`."},"required":false,"description":"Invitation status; `expired` is derived from `expiresAt`.","name":"status","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":100,"description":"Substring match over the invited address or name."},"required":false,"description":"Substring match over the invited address or name.","name":"search","in":"query"}],"responses":{"200":{"description":"Invitations of the room, newest first. `truncated` is true when more invitations matched than were returned.","content":{"application/json":{"schema":{"type":"object","properties":{"invitations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Invitation id."},"kind":{"type":"string","enum":["user","guest"],"description":"Invitation target: an internal firm user or an external guest (ADR-0005 §4)."},"status":{"type":"string","enum":["pending","accepted","revoked","expired"],"description":"Invitation status; `expired` is derived from `expiresAt`."},"language":{"type":"string","enum":["nl","en"],"description":"Invitation language (ORG-06; FR/DE later)."},"email":{"type":"string","maxLength":254,"format":"email","description":"Invited address (firm-authorized read; never logged, never in audit payloads)."},"name":{"type":"string","nullable":true,"minLength":1,"maxLength":200,"description":"Invited person's name when known; null otherwise."},"role":{"type":"string","nullable":true,"enum":["firm_admin","lawyer","legal_assistant","secretary","billing","adviser","back_office","compliance",null],"description":"Firm role for a user invitation; null for a guest invitation."},"roomId":{"type":"string","nullable":true,"format":"uuid","description":"Room a guest invitation grants access to; null for a user invitation."},"groupIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":50,"description":"External groups the guest joins; empty for a user invitation."},"accessEndsAt":{"type":"string","nullable":true,"format":"date-time","description":"Access end date (PERM-09) or null; guests only."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp (UTC, ISO-8601)."},"expiresAt":{"type":"string","format":"date-time","description":"Token expiry (UTC, ISO-8601)."},"lastSentAt":{"type":"string","format":"date-time","description":"When the invitation was (re)sent last."},"delivery":{"type":"object","properties":{"status":{"type":"string","enum":["queued","sending","sent","failed","unknown"],"default":"unknown","description":"Outbox state of the latest invitation e-mail: queued (waiting), sending (being delivered), sent (accepted by the mail server), failed (the platform could not send it) or unknown (no record). Not a read receipt."},"attempts":{"type":"integer","minimum":0,"default":0,"description":"Send attempts the platform made for the latest e-mail."}},"default":{"status":"unknown","attempts":0},"description":"Delivery state of the latest invitation e-mail (support diagnosis, never content)."},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"Acceptance time, or null."},"revokedAt":{"type":"string","nullable":true,"format":"date-time","description":"Revocation time, or null."}},"required":["id","kind","status","language","email","name","role","roomId","groupIds","accessEndsAt","createdAt","expiresAt","lastSentAt","acceptedAt","revokedAt"],"additionalProperties":false,"description":"One invitation (firm-side view)."},"description":"Invitations of the room, newest first."},"truncated":{"type":"boolean","description":"True when more invitations matched than were returned (the list is partial)."}},"required":["invitations","truncated"],"description":"Room invitations with an explicit completeness signal."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant; no existence leak, PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/invitations/{invitationId}/resend":{"post":{"operationId":"resendRoomInvitation","summary":"Resend a room invitation with a fresh link","description":"Rotates the link token (the previous link stops working), extends the expiry and queues the invitation e-mail again. Only a pending or expired invitation; an accepted or revoked one answers 409 INVITATION_NOT_PENDING. An id of another room or tenant answers 404. Writes principal.invited. Every invitation carries `delivery`: the outbox state of its latest e-mail (queued, sending, sent, failed or unknown) with the attempt count, so \"no e-mail arrived\" can be diagnosed without a read receipt and without exposing the message. A resend points at its own outbox row, so the state is the latest attempt.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Invitation id."},"required":true,"description":"Invitation id.","name":"invitationId","in":"path"}],"responses":{"200":{"description":"Resent.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Invitation id."},"kind":{"type":"string","enum":["user","guest"],"description":"Invitation target: an internal firm user or an external guest (ADR-0005 §4)."},"status":{"type":"string","enum":["pending","accepted","revoked","expired"],"description":"Invitation status; `expired` is derived from `expiresAt`."},"language":{"type":"string","enum":["nl","en"],"description":"Invitation language (ORG-06; FR/DE later)."},"email":{"type":"string","maxLength":254,"format":"email","description":"Invited address (firm-authorized read; never logged, never in audit payloads)."},"name":{"type":"string","nullable":true,"minLength":1,"maxLength":200,"description":"Invited person's name when known; null otherwise."},"role":{"type":"string","nullable":true,"enum":["firm_admin","lawyer","legal_assistant","secretary","billing","adviser","back_office","compliance",null],"description":"Firm role for a user invitation; null for a guest invitation."},"roomId":{"type":"string","nullable":true,"format":"uuid","description":"Room a guest invitation grants access to; null for a user invitation."},"groupIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":50,"description":"External groups the guest joins; empty for a user invitation."},"accessEndsAt":{"type":"string","nullable":true,"format":"date-time","description":"Access end date (PERM-09) or null; guests only."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp (UTC, ISO-8601)."},"expiresAt":{"type":"string","format":"date-time","description":"Token expiry (UTC, ISO-8601)."},"lastSentAt":{"type":"string","format":"date-time","description":"When the invitation was (re)sent last."},"delivery":{"type":"object","properties":{"status":{"type":"string","enum":["queued","sending","sent","failed","unknown"],"default":"unknown","description":"Outbox state of the latest invitation e-mail: queued (waiting), sending (being delivered), sent (accepted by the mail server), failed (the platform could not send it) or unknown (no record). Not a read receipt."},"attempts":{"type":"integer","minimum":0,"default":0,"description":"Send attempts the platform made for the latest e-mail."}},"default":{"status":"unknown","attempts":0},"description":"Delivery state of the latest invitation e-mail (support diagnosis, never content)."},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"Acceptance time, or null."},"revokedAt":{"type":"string","nullable":true,"format":"date-time","description":"Revocation time, or null."}},"required":["id","kind","status","language","email","name","role","roomId","groupIds","accessEndsAt","createdAt","expiresAt","lastSentAt","acceptedAt","revokedAt"],"additionalProperties":false,"description":"One invitation (firm-side view)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no room access administration, `room.membership.manage`).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant; no existence leak, PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"INVITATION_NOT_PENDING: the invitation was already accepted or revoked","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/invitations/{invitationId}/revoke":{"post":{"operationId":"revokeRoomInvitation","summary":"Revoke a room invitation","description":"Revokes the link immediately and removes the membership the invitation created, so the person can no longer sign in to this room through it. Only a pending or expired invitation; an accepted one answers 409 INVITATION_NOT_PENDING (remove the member instead). An id of another room or tenant answers 404. Writes principal.invitation_revoked, room.membership_removed.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Invitation id."},"required":true,"description":"Invitation id.","name":"invitationId","in":"path"}],"responses":{"200":{"description":"Revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Invitation id."},"kind":{"type":"string","enum":["user","guest"],"description":"Invitation target: an internal firm user or an external guest (ADR-0005 §4)."},"status":{"type":"string","enum":["pending","accepted","revoked","expired"],"description":"Invitation status; `expired` is derived from `expiresAt`."},"language":{"type":"string","enum":["nl","en"],"description":"Invitation language (ORG-06; FR/DE later)."},"email":{"type":"string","maxLength":254,"format":"email","description":"Invited address (firm-authorized read; never logged, never in audit payloads)."},"name":{"type":"string","nullable":true,"minLength":1,"maxLength":200,"description":"Invited person's name when known; null otherwise."},"role":{"type":"string","nullable":true,"enum":["firm_admin","lawyer","legal_assistant","secretary","billing","adviser","back_office","compliance",null],"description":"Firm role for a user invitation; null for a guest invitation."},"roomId":{"type":"string","nullable":true,"format":"uuid","description":"Room a guest invitation grants access to; null for a user invitation."},"groupIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":50,"description":"External groups the guest joins; empty for a user invitation."},"accessEndsAt":{"type":"string","nullable":true,"format":"date-time","description":"Access end date (PERM-09) or null; guests only."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp (UTC, ISO-8601)."},"expiresAt":{"type":"string","format":"date-time","description":"Token expiry (UTC, ISO-8601)."},"lastSentAt":{"type":"string","format":"date-time","description":"When the invitation was (re)sent last."},"delivery":{"type":"object","properties":{"status":{"type":"string","enum":["queued","sending","sent","failed","unknown"],"default":"unknown","description":"Outbox state of the latest invitation e-mail: queued (waiting), sending (being delivered), sent (accepted by the mail server), failed (the platform could not send it) or unknown (no record). Not a read receipt."},"attempts":{"type":"integer","minimum":0,"default":0,"description":"Send attempts the platform made for the latest e-mail."}},"default":{"status":"unknown","attempts":0},"description":"Delivery state of the latest invitation e-mail (support diagnosis, never content)."},"acceptedAt":{"type":"string","nullable":true,"format":"date-time","description":"Acceptance time, or null."},"revokedAt":{"type":"string","nullable":true,"format":"date-time","description":"Revocation time, or null."}},"required":["id","kind","status","language","email","name","role","roomId","groupIds","accessEndsAt","createdAt","expiresAt","lastSentAt","acceptedAt","revokedAt"],"additionalProperties":false,"description":"One invitation (firm-side view)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no room access administration, `room.membership.manage`).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant; no existence leak, PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"INVITATION_NOT_PENDING: the invitation was already accepted","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/auth/sms/start":{"post":{"operationId":"startGuestSms","summary":"Send the SMS code of this firm (guest second factor)","description":"ADR-0003 D6/D7, ADR-0026: a code-based guest session asks for the SMS code of its guest principal in the path tenant. The code (6 digits, 5 minutes, single use, 3 attempts) goes to the number the firm entered, never to a number the guest supplies; 3 codes per hour and 6 per 24 hours per principal. After 10 wrong SMS codes within 24 hours for the principal or for the number (across principals and firms) the SMS step is locked until those failures are older than 24 hours (429 RATE_LIMITED, ADR-0042). When the firm's daily SMS budget (`smsDailyBudget`, default 200 per 24 hours) is used up the answer is 429 SMS_BUDGET_EXCEEDED and auth.sms_budget_exceeded is written. A principal without a number answers 409 CONFLICT (the portal says 'ask the firm to enable secure viewing'); a firm user's session answers 404. Writes auth.guest_code_sent.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"202":{"description":"Queued.","content":{"application/json":{"schema":{"type":"object","properties":{"sent":{"type":"boolean","enum":[true]},"phoneHint":{"type":"string","minLength":3,"maxLength":32,"description":"Masked number the code went to (last two digits only)."}},"required":["sent","phoneHint"],"additionalProperties":false,"description":"The SMS code was queued to the number the firm entered."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant; no existence leak, PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"CONFLICT: no number on the guest principal","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"RATE_LIMITED: code budget of the principal used up or SMS step locked after too many wrong codes; SMS_BUDGET_EXCEEDED: the firm’s daily SMS budget is used up.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/auth/sms/verify":{"post":{"operationId":"verifyGuestSms","summary":"Verify the SMS code (guest second factor)","description":"Verifies the SMS code of this session and guest principal in constant time and records the per-tenant factor (`auth_session_factor` with the hash of the number the code went to). From then on the session counts as `mfa` in this tenant only, while the number is unchanged (ADR-0003 D7). Every failure is the same 401. Writes auth.step_up_succeeded or auth.step_up_failed.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","pattern":"^\\d{6}$"}},"required":["code"],"additionalProperties":false,"description":"The 6-digit SMS code."}}}},"responses":{"200":{"description":"Verified.","content":{"application/json":{"schema":{"type":"object","properties":{"authStrength":{"type":"string","enum":["mfa"]}},"required":["authStrength"],"additionalProperties":false,"description":"The session now counts as two-factor in this tenant (ADR-0003 D7)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant; no existence leak, PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/my-rooms":{"get":{"operationId":"listMyRooms","summary":"List the caller's own rooms","description":"Rooms of the path tenant the caller is a member of (the guest home, ADR-0003 D7 portal home): name, type, firm name and whether the SMS step is still needed. No document names. Membership decided through `@ddr/policy` (`room.read`, a step-up outcome is reported as `step_up_required`); a caller without a principal in the tenant gets an empty list. Navigation read: no audit event.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"Rooms.","content":{"application/json":{"schema":{"type":"object","properties":{"rooms":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true,"minLength":1,"maxLength":200},"type":{"type":"string","nullable":true,"enum":["client_portal","litigation","mortgage_advice",null]},"firmName":{"type":"string","nullable":true,"minLength":1,"maxLength":200},"access":{"type":"string","enum":["open","step_up_required"],"description":"`step_up_required`: the room needs the SMS code of this firm first."},"edition":{"type":"string","enum":["general","transaction","legal","finance","corporate"],"description":"Room edition: the kind of dataroom (general, transaction, legal, finance, corporate)."}},"required":["id","name","type","firmName","access"],"additionalProperties":false,"description":"A room the caller is a member of."}}},"required":["rooms"],"additionalProperties":false,"description":"The caller's rooms in this tenant (membership-based)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant; no existence leak, PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/invitations/{token}":{"get":{"operationId":"getInvitationByToken","summary":"Read an invitation by its token (public landing)","description":"Public landing data for the holder of the invitation link (S-AUTH-04, S-MAIL-01): the firm name, the inviter name, a masked invited address and the accept-flow step the UI must render. The token is the only credential and is not a session, so this operation needs no negative authorization test. An expired, accepted or revoked invitation still answers 200 with that status and a null nextStep, so the UI renders S-AUTH-06; an unknown token answers 404. Names nothing but the firm and the inviter: no room, matter, client or document name (S-MAIL-01, rule 1).","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Invitation token (32 random bytes, base64url). Treat as a secret."},"required":true,"description":"Invitation token (32 random bytes, base64url). Treat as a secret.","name":"token","in":"path"}],"responses":{"200":{"description":"Public invitation landing data.","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["user","guest"],"description":"Invitation target: an internal firm user or an external guest (ADR-0005 §4)."},"status":{"type":"string","enum":["pending","accepted","revoked","expired"],"description":"Invitation status; `expired` is derived from `expiresAt`."},"language":{"type":"string","enum":["nl","en"],"description":"Invitation language (ORG-06; FR/DE later)."},"firmName":{"type":"string","minLength":1,"maxLength":200,"description":"Firm the invitation belongs to."},"inviterName":{"type":"string","nullable":true,"minLength":1,"maxLength":200,"description":"Inviting person's display name, or null."},"recipientEmailHint":{"type":"string","minLength":3,"maxLength":254,"description":"Masked invited address (j***@example.org); never the full address on a public read."},"recipientName":{"type":"string","nullable":true,"minLength":1,"maxLength":200,"description":"Known invited name, or null."},"nextStep":{"type":"string","nullable":true,"enum":["register","mfa","terms","done",null],"description":"Step the UI renders; null when the invitation is expired, accepted or revoked."},"termsRequired":{"type":"boolean","description":"True when the room terms still need accepting (ORG-07 hook, room-terms.ts)."},"expiresAt":{"type":"string","format":"date-time","description":"Token expiry (UTC, ISO-8601)."}},"required":["kind","status","language","firmName","inviterName","recipientEmailHint","recipientName","nextStep","termsRequired","expiresAt"],"additionalProperties":false,"description":"Public invitation landing data; masked address, no room or content names."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown token (code NOT_FOUND).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/invitations/{token}/accept":{"post":{"operationId":"acceptInvitation","summary":"Accept an invitation and bind the signed-in identity","description":"Completes the accept flow after registration and MFA (ORG-04, S-AUTH-04). The caller must hold a session whose verified address matches the invited address; the invitation is then bound to a new principal and never reactivates a deactivated one (ADR-0003 D8, D3a). An expired, already accepted or revoked invitation answers 409 with its state code (INVITATION_EXPIRED, INVITATION_ALREADY_ACCEPTED, INVITATION_REVOKED); a mismatching verified address answers 403 INVITATION_EMAIL_MISMATCH; a disabled identity that several tenants share answers 409 IDENTITY_SHARED. `nextStep` routes the UI to the room terms (ORG-07, `room-terms.ts`) or done. Writes principal.invitation_accepted. The token stays single use and is invalidated on success.","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Invitation token (32 random bytes, base64url). Treat as a secret."},"required":true,"description":"Invitation token (32 random bytes, base64url). Treat as a secret.","name":"token","in":"path"}],"responses":{"200":{"description":"Accepted.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["accepted"],"description":"The invitation is now accepted."},"principalId":{"type":"string","format":"uuid","description":"The principal the invitation was bound to."},"nextStep":{"type":"string","enum":["register","mfa","terms","done"],"description":"Step the UI renders next (terms or done)."},"roomId":{"type":"string","nullable":true,"format":"uuid","description":"Room the guest was bound to, or null for a firm user."}},"required":["status","principalId","nextStep","roomId"],"additionalProperties":false,"description":"Accepted invitation and the next accept-flow step."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"INVITATION_EMAIL_MISMATCH: the verified address differs from the invited address.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown token (code NOT_FOUND).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"INVITATION_EXPIRED, INVITATION_ALREADY_ACCEPTED, INVITATION_REVOKED or IDENTITY_SHARED: the invitation cannot be accepted in its current state","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/search":{"get":{"operationId":"searchNames","summary":"Search node names and document metadata","description":"Name and metadata search (SRCH-01, UX-L22/L24/L25). Matches node and file names through `ddr_search_name_matches` (`pg_trgm` + unaccent: partial words, typos and diacritics, ADR-0015) and filters on the closed SRCH-04 facet set (document type, tags, modified date range, language, version status, uploader, the calling viewer's read/unread state and the privileged flag), scoped to a room, a matter or every room of the tenant the caller may see. Matches are materialised before the visibility join, so a folder or document the caller may not see never appears (ADR-0005 §8, SRCH-05; ADR-0015 D4). Results carry names and metadata only: this mode never returns document text or a snippet (SRCH-05). Each result carries its room name and the breadcrumb of visible ancestor folders (`roomName`, `path`), ranked exact > prefix > word > substring > typo > trigram similarity. The scope target `roomId`/`matterId` is required for the matching scope and refused for another; an invisible target is 404. Every candidate is checked with `@ddr/policy` `node.read` over its ancestor chain before it is returned, and each search emits one `search.performed` audit event with the scope, the result count and the filter codes, never the query text (ADR-0006 D4). Of the SRCH-04 facets, the modified date range (`modifiedFrom`/`modifiedTo`, inclusive, over the node's `updatedAt`) is evaluated inside the authorized candidate set before the page is cut; `type`, `tag`, `language`, `status`, `uploader`, `readState` and `privileged` are answered 400 instead of an unfiltered page (name nodes carry no document version facts; `type`/`tag`/`language`/`privileged` wait for the DOC-11 metadata columns, T-260914-247b).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant whose rooms are searched."},"required":true,"description":"Tenant whose rooms are searched.","name":"tenantId","in":"path"},{"schema":{"type":"string","minLength":2,"maxLength":200,"description":"Query text, trimmed, 2..200 characters; client data, never logged (UX-L25)."},"required":true,"description":"Query text, trimmed, 2..200 characters; client data, never logged (UX-L25).","name":"q","in":"query"},{"schema":{"type":"string","enum":["room","matter","tenant"],"description":"Search scope: room, matter or tenant (UX-L22, S-FIRM-07)."},"required":true,"description":"Search scope: room, matter or tenant (UX-L22, S-FIRM-07).","name":"scope","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Target room; required when scope is room, omitted otherwise."},"required":false,"description":"Target room; required when scope is room, omitted otherwise.","name":"roomId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Target matter; required when scope is matter, omitted otherwise."},"required":false,"description":"Target matter; required when scope is matter, omitted otherwise.","name":"matterId","in":"query"},{"schema":{"type":"array","items":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"DOC-11 document type code (E20 document type id, lower snake case)."},"minItems":1,"maxItems":20,"description":"Only these DOC-11 document types (SRCH-04 \"Type\")."},"required":false,"description":"Only these DOC-11 document types (SRCH-04 \"Type\").","name":"type","in":"query"},{"schema":{"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"description":"Document tag filter value (DOC-11); client data, never logged."},"minItems":1,"maxItems":20,"description":"Only documents carrying at least one of these tags (SRCH-04 \"Tags\")."},"required":false,"description":"Only documents carrying at least one of these tags (SRCH-04 \"Tags\").","name":"tag","in":"query"},{"schema":{"type":"string","format":"date-time","description":"Inclusive lower bound on the modified timestamp (SRCH-04 \"Modified\")."},"required":false,"description":"Inclusive lower bound on the modified timestamp (SRCH-04 \"Modified\").","name":"modifiedFrom","in":"query"},{"schema":{"type":"string","format":"date-time","description":"Inclusive upper bound on the modified timestamp (SRCH-04 \"Modified\")."},"required":false,"description":"Inclusive upper bound on the modified timestamp (SRCH-04 \"Modified\").","name":"modifiedTo","in":"query"},{"schema":{"type":"string","enum":["nl","en","other"],"description":"Only documents in this language (SRCH-04 \"Language\")."},"required":false,"description":"Only documents in this language (SRCH-04 \"Language\").","name":"language","in":"query"},{"schema":{"type":"string","enum":["uploading","scanning","available","rejected","failed"],"description":"Only documents whose current version is in this status (SRCH-04 \"Status\", ADR-0007 D3)."},"required":false,"description":"Only documents whose current version is in this status (SRCH-04 \"Status\", ADR-0007 D3).","name":"status","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Only documents uploaded by this principal id (SRCH-04 \"Uploaded by\")."},"required":false,"description":"Only documents uploaded by this principal id (SRCH-04 \"Uploaded by\").","name":"uploader","in":"query"},{"schema":{"type":"string","enum":["read","unread"],"description":"Only read or unread documents for the calling viewer (SRCH-04 \"Read/unread\", UX-L25)."},"required":false,"description":"Only read or unread documents for the calling viewer (SRCH-04 \"Read/unread\", UX-L25).","name":"readState","in":"query"},{"schema":{"type":"string","enum":["true","false"],"description":"The string \"true\" keeps only privileged documents, \"false\" only non-privileged ones (SRCH-04 \"Privileged\"; DOC-11)."},"required":false,"description":"The string \"true\" keeps only privileged documents, \"false\" only non-privileged ones (SRCH-04 \"Privileged\"; DOC-11).","name":"privileged","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":200,"description":"Opaque keyset cursor from the previous page; null on the last page."},"required":false,"description":"Opaque keyset cursor from the previous page; null on the last page.","name":"cursor","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page size, 1-100 (default 25)."},"required":false,"description":"Page size, 1-100 (default 25).","name":"limit","in":"query"}],"responses":{"200":{"description":"One page of name and metadata results.","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"nodeId":{"type":"string","format":"uuid","description":"Index node id of the result (ADR-0005 §6)."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Document row; null for a folder result (INT-F08, ADR-0007 D3)."},"roomId":{"type":"string","format":"uuid","description":"Room the result belongs to."},"matterId":{"type":"string","nullable":true,"format":"uuid","description":"Matter of the room, or null when the room has none."},"kind":{"type":"string","enum":["folder","document","placeholder"],"description":"Index node kind: folder, document or placeholder (expected document)."},"title":{"type":"string","description":"Node title (client data; never logged or audited)."},"indexNumber":{"type":"string","nullable":true,"maxLength":63,"pattern":"^[1-9]\\d*(\\.[1-9]\\d*)*$","description":"Position-derived index number, or null when hidden (DOC-04) or not applicable (DOC-02)."},"matchedField":{"type":"string","enum":["name","metadata","content","text_recognition"],"description":"Why the row matched: name, metadata, content or OCR text (UX-L23)."},"modifiedAt":{"type":"string","nullable":true,"format":"date-time","description":"Last modification timestamp of the matched version or node, or null when unknown."},"roomName":{"type":"string","nullable":true,"description":"Name of the room the result lives in, for the result breadcrumb (client data; never logged)."},"path":{"type":"array","items":{"type":"object","properties":{"nodeId":{"type":"string","format":"uuid","description":"Folder node id; opens the folder in the room index."},"title":{"type":"string","description":"Folder title (client data; never logged or audited)."}},"required":["nodeId","title"],"additionalProperties":false,"description":"Ancestor folder of a search result (breadcrumb segment)."},"maxItems":64,"description":"Ancestor folders of the result, room root excluded, outermost first (the breadcrumb). Only folders the caller may see on the way to a visible result."}},"required":["nodeId","documentId","roomId","matterId","kind","title","indexNumber","matchedField","modifiedAt","roomName","path"],"additionalProperties":false,"description":"Name/metadata result (SRCH-01). Strict: never carries content or a snippet (SRCH-05)."}},"scope":{"type":"string","enum":["room","matter","tenant"],"description":"Effective scope that was searched (UX-L22)."},"nextCursor":{"type":"string","nullable":true,"description":"Opaque cursor for the next page; null on the last page."}},"required":["items","scope","nextCursor"],"description":"One page of name and metadata results (SRCH-01)."}}}},"400":{"description":"Invalid query (code BAD_REQUEST): a query shorter than 2 or longer than 200 characters, an unknown filter key, a scope/target mismatch or an out-of-range cursor/limit.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"The scope target (room or matter) does not exist or is not visible to the caller (code NOT_FOUND, ADR-0005 §8).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"AUDIT_UNAVAILABLE: the audit event could not be written; nothing was served (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/search/content":{"get":{"operationId":"searchContent","summary":"Full-text search in document content","description":"Full-text content search (SRCH-02, SRCH-05, UX-L22/L23/L25). Matches `document_page_text` through `ddr_search_page_matches` (Dutch/English/simple `tsvector`, ADR-0015) and returns the matching page for the VIEW-12 deep link. The candidate set is capped at 2000 matches **before** the visibility join and paginated (ADR-0015 D5), so broad searches stay bounded. Only the current version is searched unless `includeOlderVersions` is the string \"true\", which widens the match to every live version (same RLS, same cap, one result per document with its best page, the policy decided with the matched version’s status); OCR text matches report `text_recognition`. Snippets are `ts_headline` output computed only over permitted nodes in the caller's RLS query (ADR-0015 D4 rule 3) and are null when the caller may not view the document; a document without view permission never appears as a result at all (SRCH-05). The scope target rules and the closed SRCH-04 filters (including read/unread and privileged) are shared with `searchNames`. Of the SRCH-04 facets, version `status`, `uploader` and the modified date range (`modifiedFrom`/`modifiedTo`, inclusive, over the matched version) are evaluated inside the authorized candidate set before the page is cut; `type`, `tag`, `language`, `readState` and `privileged` are answered 400 instead of a silently different page (`type`/`tag`/`language`/`privileged` wait for the DOC-11 metadata columns, T-260914-247b; `readState` has no per-viewer read-tracking source on the server). Query syntax: plain words are stemmed (Dutch, English, simple; diacritic-insensitive), \"quoted phrases\" keep word order, `word*` is a prefix and the last word also matches as a prefix while typing; all words must match (AND). Every document is decided with `@ddr/policy` `document.view` over its ancestor chain before it is returned; one result per document with its best page. The snippet is escaped text with `<mark>` around the matches (ADR-0027). Each search emits one `search.performed` audit event with the scope, the result count and the filter codes (`content`, `phrase`, `prefix`, plus `status`/`uploader`/`modified`/`older_versions` when those filters are set), never the query text (ADR-0006 D4).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant whose rooms are searched."},"required":true,"description":"Tenant whose rooms are searched.","name":"tenantId","in":"path"},{"schema":{"type":"string","minLength":2,"maxLength":200,"description":"Query text, trimmed, 2..200 characters; client data, never logged (UX-L25)."},"required":true,"description":"Query text, trimmed, 2..200 characters; client data, never logged (UX-L25).","name":"q","in":"query"},{"schema":{"type":"string","enum":["room","matter","tenant"],"description":"Search scope: room, matter or tenant (UX-L22, S-FIRM-07)."},"required":true,"description":"Search scope: room, matter or tenant (UX-L22, S-FIRM-07).","name":"scope","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Target room; required when scope is room, omitted otherwise."},"required":false,"description":"Target room; required when scope is room, omitted otherwise.","name":"roomId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Target matter; required when scope is matter, omitted otherwise."},"required":false,"description":"Target matter; required when scope is matter, omitted otherwise.","name":"matterId","in":"query"},{"schema":{"type":"array","items":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"DOC-11 document type code (E20 document type id, lower snake case)."},"minItems":1,"maxItems":20,"description":"Only these DOC-11 document types (SRCH-04 \"Type\")."},"required":false,"description":"Only these DOC-11 document types (SRCH-04 \"Type\").","name":"type","in":"query"},{"schema":{"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"description":"Document tag filter value (DOC-11); client data, never logged."},"minItems":1,"maxItems":20,"description":"Only documents carrying at least one of these tags (SRCH-04 \"Tags\")."},"required":false,"description":"Only documents carrying at least one of these tags (SRCH-04 \"Tags\").","name":"tag","in":"query"},{"schema":{"type":"string","format":"date-time","description":"Inclusive lower bound on the modified timestamp (SRCH-04 \"Modified\")."},"required":false,"description":"Inclusive lower bound on the modified timestamp (SRCH-04 \"Modified\").","name":"modifiedFrom","in":"query"},{"schema":{"type":"string","format":"date-time","description":"Inclusive upper bound on the modified timestamp (SRCH-04 \"Modified\")."},"required":false,"description":"Inclusive upper bound on the modified timestamp (SRCH-04 \"Modified\").","name":"modifiedTo","in":"query"},{"schema":{"type":"string","enum":["nl","en","other"],"description":"Only documents in this language (SRCH-04 \"Language\")."},"required":false,"description":"Only documents in this language (SRCH-04 \"Language\").","name":"language","in":"query"},{"schema":{"type":"string","enum":["uploading","scanning","available","rejected","failed"],"description":"Only documents whose current version is in this status (SRCH-04 \"Status\", ADR-0007 D3)."},"required":false,"description":"Only documents whose current version is in this status (SRCH-04 \"Status\", ADR-0007 D3).","name":"status","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Only documents uploaded by this principal id (SRCH-04 \"Uploaded by\")."},"required":false,"description":"Only documents uploaded by this principal id (SRCH-04 \"Uploaded by\").","name":"uploader","in":"query"},{"schema":{"type":"string","enum":["read","unread"],"description":"Only read or unread documents for the calling viewer (SRCH-04 \"Read/unread\", UX-L25)."},"required":false,"description":"Only read or unread documents for the calling viewer (SRCH-04 \"Read/unread\", UX-L25).","name":"readState","in":"query"},{"schema":{"type":"string","enum":["true","false"],"description":"The string \"true\" keeps only privileged documents, \"false\" only non-privileged ones (SRCH-04 \"Privileged\"; DOC-11)."},"required":false,"description":"The string \"true\" keeps only privileged documents, \"false\" only non-privileged ones (SRCH-04 \"Privileged\"; DOC-11).","name":"privileged","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":200,"description":"Opaque keyset cursor from the previous page; null on the last page."},"required":false,"description":"Opaque keyset cursor from the previous page; null on the last page.","name":"cursor","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page size, 1-100 (default 25)."},"required":false,"description":"Page size, 1-100 (default 25).","name":"limit","in":"query"},{"schema":{"type":"string","enum":["true","false"],"description":"The string \"true\" also searches non-current versions; defaults to \"false\" (SRCH-02)."},"required":false,"description":"The string \"true\" also searches non-current versions; defaults to \"false\" (SRCH-02).","name":"includeOlderVersions","in":"query"}],"responses":{"200":{"description":"One page of content results.","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"nodeId":{"type":"string","format":"uuid","description":"Index node id of the result (ADR-0005 §6)."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Document row; null for a folder result (INT-F08, ADR-0007 D3)."},"roomId":{"type":"string","format":"uuid","description":"Room the result belongs to."},"matterId":{"type":"string","nullable":true,"format":"uuid","description":"Matter of the room, or null when the room has none."},"kind":{"type":"string","enum":["folder","document","placeholder"],"description":"Index node kind: folder, document or placeholder (expected document)."},"title":{"type":"string","description":"Node title (client data; never logged or audited)."},"indexNumber":{"type":"string","nullable":true,"maxLength":63,"pattern":"^[1-9]\\d*(\\.[1-9]\\d*)*$","description":"Position-derived index number, or null when hidden (DOC-04) or not applicable (DOC-02)."},"matchedField":{"type":"string","enum":["name","metadata","content","text_recognition"],"description":"Why the row matched: name, metadata, content or OCR text (UX-L23)."},"modifiedAt":{"type":"string","nullable":true,"format":"date-time","description":"Last modification timestamp of the matched version or node, or null when unknown."},"roomName":{"type":"string","nullable":true,"description":"Name of the room the document lives in, to tell tenant-wide hits apart (client data; never logged). SRCH-02."},"snippet":{"type":"string","nullable":true,"description":"Highlighted snippet, or null without view permission (SRCH-05); never raw page text."},"pageNo":{"type":"integer","nullable":true,"minimum":1,"description":"Matching page for the deep link, or null (VIEW-12)."}},"required":["nodeId","documentId","roomId","matterId","kind","title","indexNumber","matchedField","modifiedAt","snippet","pageNo"],"additionalProperties":false,"description":"Content result (SRCH-02); the snippet is permission-filtered (SRCH-05)."}},"scope":{"type":"string","enum":["room","matter","tenant"],"description":"Effective scope that was searched (UX-L22)."},"includeOlderVersions":{"type":"boolean","description":"Whether non-current versions were searched (SRCH-02)."},"candidateCap":{"type":"integer","minimum":1,"maximum":2000,"description":"Candidate cap applied before the visibility join (2000, ADR-0015 D5)."},"nextCursor":{"type":"string","nullable":true,"description":"Opaque cursor for the next page; null on the last page."}},"required":["items","scope","includeOlderVersions","candidateCap","nextCursor"],"description":"One page of full-text content results (SRCH-02)."}}}},"400":{"description":"Invalid query (code BAD_REQUEST): a query shorter than 2 or longer than 200 characters, an unknown filter key, a scope/target mismatch or an out-of-range cursor/limit.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"The scope target (room or matter) does not exist or is not visible to the caller (code NOT_FOUND, ADR-0005 §8).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"AUDIT_UNAVAILABLE: the audit event could not be written; nothing was served (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/message-threads":{"get":{"operationId":"listMessageThreads","summary":"List the message threads of a room","description":"The S-ROOM-12 thread list, newest activity first with a cursor and the total unread count (INT-04). A thread is per room, or anchored to one document for a per-file thread (HYP-11, filter by `documentId`). Threads the caller cannot see are absent, and another tenant or no room access answers 404 (PERM-02). Every payload is ids, the closed visibility enum, timestamps and counts: never a message body or a file name (rule 1). Reading is a navigation action: no audit event (ADR-0006 D4).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","minLength":1,"maxLength":512,"description":"Opaque cursor from `nextCursor`; omit it for the first page."},"required":false,"description":"Opaque cursor from `nextCursor`; omit it for the first page.","name":"cursor","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page size (1..100, default 20)."},"required":false,"description":"Page size (1..100, default 20).","name":"limit","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Only the per-file threads of this document (HYP-11)."},"required":false,"description":"Only the per-file threads of this document (HYP-11).","name":"documentId","in":"query"},{"schema":{"type":"string","enum":["room","group","internal_only"],"description":"Only threads with this visibility."},"required":false,"description":"Only threads with this visibility.","name":"visibility","in":"query"}],"responses":{"200":{"description":"One page of the room thread list with the total unread count.","content":{"application/json":{"schema":{"type":"object","properties":{"threads":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Thread id."},"roomId":{"type":"string","format":"uuid","description":"Room that owns the thread."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Anchored document for a per-file thread (HYP-11); null for a room-wide thread."},"visibility":{"type":"string","enum":["room","group","internal_only"],"description":"Thread visibility (closed list): room = all members, group = the participant groups, internal_only = firm-internal only (PERM-05)."},"participantGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Room groups that take part: the external groups of a `group` thread, every group the caller may see of a `room` thread, the internal groups of an `internal_only` thread (never an external one)."},"createdByPrincipalId":{"type":"string","format":"uuid","description":"Principal that started the thread."},"createdAt":{"type":"string","format":"date-time","description":"When the thread was created (UTC, ISO-8601)."},"lastMessageAt":{"type":"string","nullable":true,"format":"date-time","description":"Timestamp of the newest message; null before the first message."},"messageCount":{"type":"integer","minimum":0,"description":"How many messages the thread holds."},"unreadCount":{"type":"integer","minimum":0,"description":"The caller own unread messages in this thread."},"readByCount":{"type":"integer","minimum":0,"description":"How many participants have read the thread."},"participantCount":{"type":"integer","minimum":1,"description":"How many principals take part."}},"required":["id","roomId","documentId","visibility","participantGroupIds","createdByPrincipalId","createdAt","lastMessageAt","messageCount","unreadCount","readByCount","participantCount"],"additionalProperties":false,"description":"One secure message thread (ids, the closed visibility, timestamps and counts only; never a message body or a file name)."},"description":"One page, newest activity first."},"labels":{"type":"object","properties":{"groups":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"description":"Room group names by id, resolved at read time for this reader."},"principals":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"description":"Display names of senders and participants by id, resolved at read time for this reader."},"documents":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"description":"Document titles by id, resolved at read time for this reader."}},"required":["groups","principals","documents"],"additionalProperties":false,"description":"Read-time labels for the ids on one page (never stored with a thread or message)."},"unreadCount":{"type":"integer","minimum":0,"description":"Total unread messages across the visible threads (the S-ROOM-12 thread-list badge)."},"nextCursor":{"type":"string","nullable":true,"minLength":1,"maxLength":512,"description":"Cursor for the next page; null on the last page."}},"required":["threads","unreadCount","nextCursor"],"additionalProperties":false,"description":"One page of the room thread list with the total unread count."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, no room access, an unknown or hidden thread, or the path is not registered yet (T-260914-31ea). A thread or message the caller cannot see answers the same 404 (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"post":{"operationId":"createMessageThread","summary":"Start a message thread","description":"Starts a thread with a closed visibility and at least one participant group (S-ROOM-12 \"new thread\": choose participants). `documentId` anchors a per-file thread (HYP-11). Requires `message.post`; a thread only ever narrows the room access model, so an `internal_only` thread never lists an external group (PERM-05). Starting a thread is not itself an audited action: ADR-0006 D4 catalogues only `message.posted` and `message.read` (wired in T-260914-31ea).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"visibility":{"type":"string","enum":["room","group","internal_only"],"description":"Thread visibility (closed list): room = all members, group = the participant groups, internal_only = firm-internal only (PERM-05)."},"participantGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":50,"default":[],"description":"Room groups that take part in a `group` thread (at least one external group of the room). Ignored for `room` (every member) and `internal_only` (the internal groups). A guest may only name its own group."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Anchors a per-file thread (HYP-11); omit or null for a room-wide thread."}},"required":["visibility"],"additionalProperties":false,"description":"Start a thread with a visibility (the audience) and, for a group thread, its groups."}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Thread id."},"roomId":{"type":"string","format":"uuid","description":"Room that owns the thread."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Anchored document for a per-file thread (HYP-11); null for a room-wide thread."},"visibility":{"type":"string","enum":["room","group","internal_only"],"description":"Thread visibility (closed list): room = all members, group = the participant groups, internal_only = firm-internal only (PERM-05)."},"participantGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Room groups that take part: the external groups of a `group` thread, every group the caller may see of a `room` thread, the internal groups of an `internal_only` thread (never an external one)."},"createdByPrincipalId":{"type":"string","format":"uuid","description":"Principal that started the thread."},"createdAt":{"type":"string","format":"date-time","description":"When the thread was created (UTC, ISO-8601)."},"lastMessageAt":{"type":"string","nullable":true,"format":"date-time","description":"Timestamp of the newest message; null before the first message."},"messageCount":{"type":"integer","minimum":0,"description":"How many messages the thread holds."},"unreadCount":{"type":"integer","minimum":0,"description":"The caller own unread messages in this thread."},"readByCount":{"type":"integer","minimum":0,"description":"How many participants have read the thread."},"participantCount":{"type":"integer","minimum":1,"description":"How many principals take part."}},"required":["id","roomId","documentId","visibility","participantGroupIds","createdByPrincipalId","createdAt","lastMessageAt","messageCount","unreadCount","readByCount","participantCount"],"additionalProperties":false,"description":"One secure message thread (ids, the closed visibility, timestamps and counts only; never a message body or a file name)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `message.post` permission).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, no room access, an unknown or hidden thread, or the path is not registered yet (T-260914-31ea). A thread or message the caller cannot see answers the same 404 (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"READ_ONLY: the room is not active (ADR-0005 §8).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/message-threads/{threadId}":{"get":{"operationId":"getMessageThread","summary":"Read one message thread","description":"One thread with its visibility, participants and counts (S-ROOM-12). A thread the caller cannot see answers 404, never 403 (PERM-02). Navigation read: no audit event (ADR-0006 D4).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Thread id."},"required":true,"description":"Thread id.","name":"threadId","in":"path"}],"responses":{"200":{"description":"The thread.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Thread id."},"roomId":{"type":"string","format":"uuid","description":"Room that owns the thread."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Anchored document for a per-file thread (HYP-11); null for a room-wide thread."},"visibility":{"type":"string","enum":["room","group","internal_only"],"description":"Thread visibility (closed list): room = all members, group = the participant groups, internal_only = firm-internal only (PERM-05)."},"participantGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Room groups that take part: the external groups of a `group` thread, every group the caller may see of a `room` thread, the internal groups of an `internal_only` thread (never an external one)."},"createdByPrincipalId":{"type":"string","format":"uuid","description":"Principal that started the thread."},"createdAt":{"type":"string","format":"date-time","description":"When the thread was created (UTC, ISO-8601)."},"lastMessageAt":{"type":"string","nullable":true,"format":"date-time","description":"Timestamp of the newest message; null before the first message."},"messageCount":{"type":"integer","minimum":0,"description":"How many messages the thread holds."},"unreadCount":{"type":"integer","minimum":0,"description":"The caller own unread messages in this thread."},"readByCount":{"type":"integer","minimum":0,"description":"How many participants have read the thread."},"participantCount":{"type":"integer","minimum":1,"description":"How many principals take part."}},"required":["id","roomId","documentId","visibility","participantGroupIds","createdByPrincipalId","createdAt","lastMessageAt","messageCount","unreadCount","readByCount","participantCount"],"additionalProperties":false,"description":"One secure message thread (ids, the closed visibility, timestamps and counts only; never a message body or a file name)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, no room access, an unknown or hidden thread, or the path is not registered yet (T-260914-31ea). A thread or message the caller cannot see answers the same 404 (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/message-threads/{threadId}/messages":{"get":{"operationId":"listMessages","summary":"List the messages of a thread","description":"The S-ROOM-12 conversation, oldest first with a cursor. Each message carries a plain-text body, the closed state enum, id-only document references and the \"Read by 2 of 3\" counts; a linked document is resolved by the client under its own permissions, so no file name or document content travels in a message (HYP-11, rule 1). A thread the caller cannot see answers 404 (PERM-02). Navigation read: no audit event (ADR-0006 D4).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Thread id."},"required":true,"description":"Thread id.","name":"threadId","in":"path"},{"schema":{"type":"string","minLength":1,"maxLength":512,"description":"Opaque cursor from `nextCursor`; omit it for the first page."},"required":false,"description":"Opaque cursor from `nextCursor`; omit it for the first page.","name":"cursor","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":200,"description":"Page size (1..200, default 50)."},"required":false,"description":"Page size (1..200, default 50).","name":"limit","in":"query"}],"responses":{"200":{"description":"One page of the conversation.","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Message id."},"threadId":{"type":"string","format":"uuid","description":"Thread the message belongs to."},"senderPrincipalId":{"type":"string","format":"uuid","description":"Principal that sent the message."},"senderKind":{"type":"string","enum":["user","guest","support"],"description":"Principal kind of one tenant binding."},"createdAt":{"type":"string","format":"date-time","description":"When the message was sent (UTC, ISO-8601)."},"body":{"type":"string","minLength":1,"maxLength":10000,"description":"Plain-text message body (line breaks allowed, never HTML). The only free text."},"state":{"type":"string","enum":["sent","edited","redacted"],"description":"Message lifecycle (closed list): sent = immutable original, edited = a change was recorded, redacted = the body was crypto-shredded and only metadata remains."},"documentReferences":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid","description":"Id of the referenced document; the client resolves the name."},"versionId":{"type":"string","nullable":true,"format":"uuid","description":"Pinned document version; null links to the current version. Never content."}},"required":["documentId","versionId"],"additionalProperties":false,"description":"Reference to a room document (ids only, never a file name or content)."},"maxItems":20,"description":"Documents linked by id, never a copy, a name or content (HYP-11)."},"readByCount":{"type":"integer","minimum":0,"description":"How many participants have read this message."},"participantCount":{"type":"integer","minimum":1,"description":"How many principals take part in the thread."}},"required":["id","threadId","senderPrincipalId","senderKind","createdAt","body","state","documentReferences","readByCount","participantCount"],"additionalProperties":false,"description":"One secure message. Carries a plain-text body, folder-free document ids and counts; never a file name, document title or document content (rule 1)."},"description":"One page, oldest first."},"labels":{"type":"object","properties":{"groups":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"description":"Room group names by id, resolved at read time for this reader."},"principals":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"description":"Display names of senders and participants by id, resolved at read time for this reader."},"documents":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"description":"Document titles by id, resolved at read time for this reader."}},"required":["groups","principals","documents"],"additionalProperties":false,"description":"Read-time labels for the ids on one page (never stored with a thread or message)."},"nextCursor":{"type":"string","nullable":true,"minLength":1,"maxLength":512,"description":"Cursor for the next page; null on the last page."}},"required":["messages","nextCursor"],"additionalProperties":false,"description":"One page of a thread conversation."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, no room access, an unknown or hidden thread, or the path is not registered yet (T-260914-31ea). A thread or message the caller cannot see answers the same 404 (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"post":{"operationId":"postMessage","summary":"Post a message to a thread","description":"Posts a plain-text message, optionally linking documents by id (S-ROOM-12 \"reply, attach a document from the room (link, not a copy)\"; HYP-11). Requires `message.post`; a mutating action, so a room that is not active answers 409 READ_ONLY (ADR-0005 §8). The server re-checks document access on read, never returns document content and writes `message.posted` (T-260914-31ea).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Thread id."},"required":true,"description":"Thread id.","name":"threadId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":10000,"description":"Plain-text message body (line breaks allowed, never HTML)."},"documentReferences":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid","description":"Id of the referenced document; the client resolves the name."},"versionId":{"type":"string","nullable":true,"format":"uuid","description":"Pinned document version; null links to the current version. Never content."}},"required":["documentId","versionId"],"additionalProperties":false,"description":"Reference to a room document (ids only, never a file name or content)."},"maxItems":20,"default":[],"description":"Documents to link (ids only; the server re-checks permission on read, HYP-11)."}},"required":["body"],"additionalProperties":false,"description":"Post a message, optionally with document references (ids only, never content)."}}}},"responses":{"201":{"description":"Posted.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Message id."},"threadId":{"type":"string","format":"uuid","description":"Thread the message belongs to."},"senderPrincipalId":{"type":"string","format":"uuid","description":"Principal that sent the message."},"senderKind":{"type":"string","enum":["user","guest","support"],"description":"Principal kind of one tenant binding."},"createdAt":{"type":"string","format":"date-time","description":"When the message was sent (UTC, ISO-8601)."},"body":{"type":"string","minLength":1,"maxLength":10000,"description":"Plain-text message body (line breaks allowed, never HTML). The only free text."},"state":{"type":"string","enum":["sent","edited","redacted"],"description":"Message lifecycle (closed list): sent = immutable original, edited = a change was recorded, redacted = the body was crypto-shredded and only metadata remains."},"documentReferences":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid","description":"Id of the referenced document; the client resolves the name."},"versionId":{"type":"string","nullable":true,"format":"uuid","description":"Pinned document version; null links to the current version. Never content."}},"required":["documentId","versionId"],"additionalProperties":false,"description":"Reference to a room document (ids only, never a file name or content)."},"maxItems":20,"description":"Documents linked by id, never a copy, a name or content (HYP-11)."},"readByCount":{"type":"integer","minimum":0,"description":"How many participants have read this message."},"participantCount":{"type":"integer","minimum":1,"description":"How many principals take part in the thread."}},"required":["id","threadId","senderPrincipalId","senderKind","createdAt","body","state","documentReferences","readByCount","participantCount"],"additionalProperties":false,"description":"One secure message. Carries a plain-text body, folder-free document ids and counts; never a file name, document title or document content (rule 1)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `message.post` permission).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, no room access, an unknown or hidden thread, or the path is not registered yet (T-260914-31ea). A thread or message the caller cannot see answers the same 404 (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"READ_ONLY: the room is not active (ADR-0005 §8).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/message-threads/{threadId}/receipts":{"get":{"operationId":"listMessageReadReceipts","summary":"List the read receipts of a thread","description":"Per-principal read receipts (\"Read by 2 of 3\", S-ROOM-12): principal id, kind and read time only, never content (rule 1). Readable by the participants of the thread; a thread the caller cannot see answers 404 (PERM-02). Navigation read: no audit event (ADR-0006 D4).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Thread id."},"required":true,"description":"Thread id.","name":"threadId","in":"path"}],"responses":{"200":{"description":"The per-principal receipts.","content":{"application/json":{"schema":{"type":"object","properties":{"threadId":{"type":"string","format":"uuid","description":"Thread the receipts belong to."},"participantCount":{"type":"integer","minimum":1,"description":"How many principals take part."},"readByCount":{"type":"integer","minimum":0,"description":"How many participants have read the thread."},"receipts":{"type":"array","items":{"type":"object","properties":{"principalId":{"type":"string","format":"uuid","description":"Principal that read the thread."},"principalKind":{"type":"string","enum":["user","guest","support"],"description":"Principal kind of one tenant binding."},"readAt":{"type":"string","format":"date-time","description":"When that principal last read the thread (UTC, ISO-8601)."}},"required":["principalId","principalKind","readAt"],"additionalProperties":false,"description":"One principal read receipt: ids and a timestamp only, never content."},"description":"Per-principal receipts, oldest read first (the \"Read by 2 of 3\" detail)."}},"required":["threadId","participantCount","readByCount","receipts"],"additionalProperties":false,"description":"Per-principal read receipts of one thread: ids and timestamps only, never content."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, no room access, an unknown or hidden thread, or the path is not registered yet (T-260914-31ea). A thread or message the caller cannot see answers the same 404 (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/message-threads/{threadId}/read":{"post":{"operationId":"markMessageThreadRead","summary":"Mark a thread read","description":"Records the caller read receipt, optionally up to one message (S-ROOM-12 \"mark as read\"); idempotent. Own-data receipt, but it is audit-relevant as `message.read` (ADR-0006 D4, written by T-260914-31ea). A thread the caller cannot see answers 404 (PERM-02).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Thread id."},"required":true,"description":"Thread id.","name":"threadId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"upToMessageId":{"type":"string","format":"uuid","description":"Read through this message; omit to read every message currently in the thread."}},"additionalProperties":false,"description":"Which messages the receipt covers (S-ROOM-12 \"mark as read\")."}}}},"responses":{"200":{"description":"Marked read; the caller unread count for the thread is now zero.","content":{"application/json":{"schema":{"type":"object","properties":{"threadId":{"type":"string","format":"uuid","description":"Thread that was marked read."},"readAt":{"type":"string","format":"date-time","description":"When the receipt was recorded (UTC, ISO-8601)."},"unreadCount":{"type":"number","enum":[0],"description":"Always 0 for the reader after marking read."}},"required":["threadId","readAt","unreadCount"],"additionalProperties":false,"description":"Result of marking a thread read; idempotent."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, no room access, an unknown or hidden thread, or the path is not registered yet (T-260914-31ea). A thread or message the caller cannot see answers the same 404 (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/retention/classes":{"get":{"operationId":"getRetentionCatalogue","summary":"Read the retention catalogue with the tenant durations","description":"The platform class catalogue of ADR-0012 D2 with the tenant duration per class (`retention_class_setting`, D5): min/default/max bounds, triggers, profession, legal basis and the review marker. No row means the class default. Requires `retention.read` (firm_admin, compliance or `manage` on the node); guests and support are refused with 403. Writes nothing. The routes land in T-260914-2bc8.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"Catalogue with effective tenant durations.","content":{"application/json":{"schema":{"type":"object","properties":{"classes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","enum":["legal_file","legal_financial_record","legal_liability_long","wwft_cdd","mortgage_advice_file","mortgage_supporting","mortgage_identity_copy","general_room","notary_file","notary_environmental","accountancy_record","financial_advice_file","mifid_record","mediation_file","insolvency_estate"],"description":"Platform retention class id (ADR-0012 D2); tenants cannot create classes in the MVP."},"triggers":{"type":"array","items":{"type":"string","enum":["room_closed","relationship_end","file_completed","file_cancelled"],"description":"Event that starts a retention class clock (ADR-0012 D3)."},"minItems":1,"description":"Triggers that start the class clock."},"minDuration":{"type":"string","pattern":"^P(?!$)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)W)?(?:(\\d+)D)?$","description":"ISO 8601 calendar duration of a retention period (ADR-0012 D2)."},"defaultDuration":{"type":"string","pattern":"^P(?!$)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)W)?(?:(\\d+)D)?$","description":"ISO 8601 calendar duration of a retention period (ADR-0012 D2)."},"maxDuration":{"type":"string","pattern":"^P(?!$)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)W)?(?:(\\d+)D)?$","description":"ISO 8601 calendar duration of a retention period (ADR-0012 D2)."},"effectiveDuration":{"type":"string","pattern":"^P(?!$)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)W)?(?:(\\d+)D)?$","description":"Tenant duration, or the class default when unset."},"overridden":{"type":"boolean","description":"True when the tenant set a duration for this class."},"appliesTo":{"type":"string","enum":["legal","mortgage","any","notary","accountancy","financial_planning","mediation","insolvency"],"description":"Profession a retention class applies to (ADR-0012 D2; profession profiles ADR-0058)."},"labelKey":{"type":"string","minLength":1,"description":"i18n key of the NL/EN label; copy lives in @ddr/i18n."},"basis":{"type":"string","minLength":1,"description":"Legal source reference for the retention overview."},"review":{"type":"boolean","description":"True while a lawyer has not confirmed the period."}},"required":["id","triggers","minDuration","defaultDuration","maxDuration","effectiveDuration","overridden","appliesTo","labelKey","basis","review"],"additionalProperties":false,"description":"One retention class with the tenant duration and its bounds (RET-01)."},"description":"The platform catalogue, class id order."}},"required":["classes"],"description":"Retention catalogue with the tenant durations (RET-01)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no retention right, or a guest/support session; guests and support never see retention or holds).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, or hidden from the caller; cross-tenant answers the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/retention/classes/{classId}":{"put":{"operationId":"updateRetentionClassDuration","summary":"Set the tenant duration of one retention class","description":"Sets one `retention_class_setting` within the class min/max (ADR-0012 D2, D5). Firm admins only, with step-up (`retention.settings.update`); writes `retention.schedule_changed`. A duration outside the bounds is refused with 400. Lengthening recomputes affected dates; lowering never shortens a computed date because of the append-only classes and `retention_floor` (D4). Guests and support are refused with 403. The route lands in T-260914-2bc8.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","enum":["legal_file","legal_financial_record","legal_liability_long","wwft_cdd","mortgage_advice_file","mortgage_supporting","mortgage_identity_copy","general_room","notary_file","notary_environmental","accountancy_record","financial_advice_file","mifid_record","mediation_file","insolvency_estate"],"description":"Platform retention class id (ADR-0012 D2); tenants cannot create classes in the MVP."},"required":true,"description":"Platform retention class id (ADR-0012 D2); tenants cannot create classes in the MVP.","name":"classId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"duration":{"type":"string","pattern":"^P(?!$)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)W)?(?:(\\d+)D)?$","description":"New tenant duration; must be within the class min/max (ADR-0012 D5)."}},"required":["duration"],"additionalProperties":false,"description":"Set the tenant duration of one retention class."}}}},"responses":{"200":{"description":"Stored tenant duration.","content":{"application/json":{"schema":{"type":"object","properties":{"classId":{"type":"string","enum":["legal_file","legal_financial_record","legal_liability_long","wwft_cdd","mortgage_advice_file","mortgage_supporting","mortgage_identity_copy","general_room","notary_file","notary_environmental","accountancy_record","financial_advice_file","mifid_record","mediation_file","insolvency_estate"],"description":"Platform retention class id (ADR-0012 D2); tenants cannot create classes in the MVP."},"duration":{"type":"string","pattern":"^P(?!$)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)W)?(?:(\\d+)D)?$","description":"Stored tenant duration."},"updatedBy":{"type":"string","format":"uuid","description":"Principal that set the duration."},"updatedAt":{"type":"string","format":"date-time","description":"Change timestamp (UTC, ISO-8601)."}},"required":["classId","duration","updatedBy","updatedAt"],"additionalProperties":false,"description":"Stored tenant duration of one class (ADR-0012 D5)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no retention right, or a guest/support session; guests and support never see retention or holds).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, or hidden from the caller; cross-tenant answers the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/retention/room-types":{"get":{"operationId":"getRetentionRoomTypeSchedules","summary":"Read the room-type retention schedules","description":"The `room_type_retention` mapping of ADR-0012 D5: the default classes per room type (\"schedule per matter type\"). Every room type has at least one class. Requires `retention.read`; guests and support are refused with 403. The routes land in T-260914-2bc8.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"One schedule per room type.","content":{"application/json":{"schema":{"type":"object","properties":{"schedules":{"type":"array","items":{"type":"object","properties":{"roomType":{"type":"string","enum":["client_portal","litigation","mortgage_advice"],"description":"Room type the firm allows."},"classIds":{"type":"array","items":{"type":"string","enum":["legal_file","legal_financial_record","legal_liability_long","wwft_cdd","mortgage_advice_file","mortgage_supporting","mortgage_identity_copy","general_room","notary_file","notary_environmental","accountancy_record","financial_advice_file","mifid_record","mediation_file","insolvency_estate"],"description":"Platform retention class id (ADR-0012 D2); tenants cannot create classes in the MVP."},"minItems":1,"description":"Default classes of the room type; at least one (ADR-0012 D5)."}},"required":["roomType","classIds"],"additionalProperties":false,"description":"Default classes of one room type (RET-01 schedule)."},"description":"One entry per room type."}},"required":["schedules"],"description":"Room-type retention schedules of the tenant (RET-01)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no retention right, or a guest/support session; guests and support never see retention or holds).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, or hidden from the caller; cross-tenant answers the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/retention/room-types/{roomType}":{"put":{"operationId":"putRetentionRoomTypeSchedule","summary":"Replace the default classes of one room type","description":"Replaces `room_type_retention` for one room type with at least one class (ADR-0012 D5). Firm admins only, with step-up; writes `retention.schedule_changed`. The schedule is a default, not a reset: existing rooms and documents keep their append-only classes (D5). Guests and support are refused with 403. The route lands in T-260914-2bc8.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","enum":["client_portal","litigation","mortgage_advice"],"description":"Room type the firm allows."},"required":true,"description":"Room type the firm allows.","name":"roomType","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"classIds":{"type":"array","items":{"type":"string","enum":["legal_file","legal_financial_record","legal_liability_long","wwft_cdd","mortgage_advice_file","mortgage_supporting","mortgage_identity_copy","general_room","notary_file","notary_environmental","accountancy_record","financial_advice_file","mifid_record","mediation_file","insolvency_estate"],"description":"Platform retention class id (ADR-0012 D2); tenants cannot create classes in the MVP."},"minItems":1,"description":"Replacement default classes for the room type; at least one (ADR-0012 D5)."}},"required":["classIds"],"additionalProperties":false,"description":"Replace the default classes of one room type."}}}},"responses":{"200":{"description":"Stored room-type schedule.","content":{"application/json":{"schema":{"type":"object","properties":{"roomType":{"type":"string","enum":["client_portal","litigation","mortgage_advice"],"description":"Room type the firm allows."},"classIds":{"type":"array","items":{"type":"string","enum":["legal_file","legal_financial_record","legal_liability_long","wwft_cdd","mortgage_advice_file","mortgage_supporting","mortgage_identity_copy","general_room","notary_file","notary_environmental","accountancy_record","financial_advice_file","mifid_record","mediation_file","insolvency_estate"],"description":"Platform retention class id (ADR-0012 D2); tenants cannot create classes in the MVP."},"minItems":1,"description":"Default classes of the room type; at least one (ADR-0012 D5)."}},"required":["roomType","classIds"],"additionalProperties":false,"description":"Default classes of one room type (RET-01 schedule)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no retention right, or a guest/support session; guests and support never see retention or holds).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, or hidden from the caller; cross-tenant answers the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/retention":{"get":{"operationId":"getRoomRetention","summary":"Read the retention surface of a room","description":"The room `retention_until`, `retention_floor` and `retention_evaluated_at` (Europe/Amsterdam, ADR-0012 D1, D4) with the room record classes and the hold-state projection. Requires `retention.read` (firm_admin, compliance or `manage` on the node); an internal `view` caller sees only the \"retained until\" date on a document detail, so this full surface stays with `manage` and the two firm roles. Guests and support are refused with 403 and never see a hold. Ids, dates and codes only. The route lands in T-260914-2bc8.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"Room retention surface.","content":{"application/json":{"schema":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid","description":"Room id."},"state":{"type":"string","enum":["active","frozen","closed","archived"],"description":"Room state; closing starts the retention clock (ADR-0012 D3)."},"closedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the current `room_closed` trigger was recorded (the clock start), or null."},"retentionUntil":{"type":"string","nullable":true,"format":"date","description":"Room retention_until (Europe/Amsterdam date); null means no expiry yet."},"retentionFloor":{"type":"string","nullable":true,"format":"date","description":"Latest date ever computed for the room."},"retentionEvaluatedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the date was last recomputed."},"expired":{"type":"boolean","description":"True when today (Europe/Amsterdam) is after retention_until (ADR-0012 D1)."},"eligibleForDestruction":{"type":"boolean","description":"Closed or archived, expired, no hold (grace included) and no open procedure (D8.5)."},"recordClasses":{"type":"array","items":{"type":"object","properties":{"classId":{"type":"string","enum":["legal_file","legal_financial_record","legal_liability_long","wwft_cdd","mortgage_advice_file","mortgage_supporting","mortgage_identity_copy","general_room","notary_file","notary_environmental","accountancy_record","financial_advice_file","mifid_record","mediation_file","insolvency_estate"],"description":"Platform retention class id (ADR-0012 D2); tenants cannot create classes in the MVP."},"source":{"type":"string","enum":["room_type","manual"],"description":"How the class was assigned (append-only)."},"effectiveDuration":{"type":"string","pattern":"^P(?!$)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)W)?(?:(\\d+)D)?$","description":"Tenant duration of the class, or its default."},"assignedAt":{"type":"string","format":"date-time","description":"Assignment timestamp (UTC, ISO-8601)."},"assignedBy":{"type":"string","nullable":true,"format":"uuid","description":"Principal that assigned the class, or null for a rule."}},"required":["classId","source","effectiveDuration","assignedAt","assignedBy"],"additionalProperties":false,"description":"One class of the room records (ADR-0012 D4); append-only."},"description":"Classes of the room records (index, messages, notes), append-only."},"hold":{"type":"object","properties":{"active":{"type":"boolean","description":"True when at least one hold covers the item."},"holdCount":{"type":"integer","minimum":0,"description":"Number of holds that cover the item."},"graceEndsAt":{"type":"string","nullable":true,"format":"date-time","description":"Latest grace end of a lifted hold that still covers the item, or null."}},"required":["active","holdCount","graceEndsAt"],"additionalProperties":false,"description":"Hold-state projection on a retention surface; ids and dates only (ADR-0012 D7)."},"destruction":{"type":"object","nullable":true,"properties":{"requestId":{"type":"string","format":"uuid","description":"Deletion request id."},"status":{"type":"string","enum":["requested","approved","executing","completed","failed"],"description":"Deletion request status (ADR-0012 D10)."},"coolingOffUntil":{"type":"string","nullable":true,"format":"date-time","description":"End of the 72-hour cooling-off, or null."}},"required":["requestId","status","coolingOffUntil"],"additionalProperties":false,"description":"Open or completed destruction request."}},"required":["roomId","state","closedAt","retentionUntil","retentionFloor","retentionEvaluatedAt","expired","eligibleForDestruction","recordClasses","hold","destruction"],"additionalProperties":false,"description":"Retention surface of one room; ids, dates and codes only."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no retention right, or a guest/support session; guests and support never see retention or holds).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, or hidden from the caller; cross-tenant answers the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/retention":{"get":{"operationId":"getDocumentRetention","summary":"Read the retention surface of a document","description":"The document `retention_until`, `retention_floor` and `retention_evaluated_at`, the append-only assigned classes and the hold-state projection (ADR-0012 D4, D7). Requires `retention.read`; guests and support are refused with 403 and never see a hold. No file name, title or content is returned. The route lands in T-260914-2bc8.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"}],"responses":{"200":{"description":"Document retention surface.","content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid","description":"Document id."},"roomId":{"type":"string","format":"uuid","description":"Room id."},"retentionUntil":{"type":"string","nullable":true,"format":"date","description":"Effective retention_until (Europe/Amsterdam date); null means no expiry yet."},"retentionFloor":{"type":"string","nullable":true,"format":"date","description":"Latest date ever computed (ADR-0012 D4); only an override moves it."},"retentionEvaluatedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the date was last recomputed, or null."},"classes":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid","description":"Document id."},"classId":{"type":"string","enum":["legal_file","legal_financial_record","legal_liability_long","wwft_cdd","mortgage_advice_file","mortgage_supporting","mortgage_identity_copy","general_room","notary_file","notary_environmental","accountancy_record","financial_advice_file","mifid_record","mediation_file","insolvency_estate"],"description":"Platform retention class id (ADR-0012 D2); tenants cannot create classes in the MVP."},"source":{"type":"string","enum":["room_type","folder","document_type","condition","manual"],"description":"Source of a class assignment (ADR-0012 D4); assignment is append-only."},"assignedAt":{"type":"string","format":"date-time","description":"Assignment timestamp (UTC, ISO-8601)."},"assignedBy":{"type":"string","nullable":true,"format":"uuid","description":"Principal that assigned the class, or null for a rule."}},"required":["documentId","classId","source","assignedAt","assignedBy"],"additionalProperties":false,"description":"One class assignment on a document (ADR-0012 D4); append-only."},"description":"Assigned classes, append-only."},"hold":{"type":"object","properties":{"active":{"type":"boolean","description":"True when at least one hold covers the item."},"holdCount":{"type":"integer","minimum":0,"description":"Number of holds that cover the item."},"graceEndsAt":{"type":"string","nullable":true,"format":"date-time","description":"Latest grace end of a lifted hold that still covers the item, or null."}},"required":["active","holdCount","graceEndsAt"],"additionalProperties":false,"description":"Hold-state projection on a retention surface; ids and dates only (ADR-0012 D7)."}},"required":["documentId","roomId","retentionUntil","retentionFloor","retentionEvaluatedAt","classes","hold"],"additionalProperties":false,"description":"Retention surface of one document; ids, dates and codes only."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no retention right, or a guest/support session; guests and support never see retention or holds).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, or hidden from the caller; cross-tenant answers the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/matters/{matterId}/retention":{"get":{"operationId":"getMatterRetention","summary":"Read the retention surface of a matter","description":"The latest `retention_until` over the matter rooms, with the floor, the evaluation time, the room count and the hold-state projection (ADR-0012 D4, D7). Requires `retention.read`; guests and support are refused with 403 and never see a hold. The route lands in T-260914-2bc8.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Matter id."},"required":true,"description":"Matter id.","name":"matterId","in":"path"}],"responses":{"200":{"description":"Matter retention surface.","content":{"application/json":{"schema":{"type":"object","properties":{"matterId":{"type":"string","format":"uuid","description":"Matter id."},"retentionUntil":{"type":"string","nullable":true,"format":"date","description":"Latest retention_until over the rooms of the matter; null wins (ADR-0012 D4)."},"retentionFloor":{"type":"string","nullable":true,"format":"date","description":"Latest date ever computed for the matter."},"retentionEvaluatedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the date was last recomputed."},"roomCount":{"type":"integer","minimum":0,"description":"Rooms of the matter that were evaluated."},"hold":{"type":"object","properties":{"active":{"type":"boolean","description":"True when at least one hold covers the item."},"holdCount":{"type":"integer","minimum":0,"description":"Number of holds that cover the item."},"graceEndsAt":{"type":"string","nullable":true,"format":"date-time","description":"Latest grace end of a lifted hold that still covers the item, or null."}},"required":["active","holdCount","graceEndsAt"],"additionalProperties":false,"description":"Hold-state projection on a retention surface; ids and dates only (ADR-0012 D7)."}},"required":["matterId","retentionUntil","retentionFloor","retentionEvaluatedAt","roomCount","hold"],"additionalProperties":false,"description":"Retention surface of one matter; ids, dates and codes only."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no retention right, or a guest/support session; guests and support never see retention or holds).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, or hidden from the caller; cross-tenant answers the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/retention/classes":{"post":{"operationId":"assignRetentionClass","summary":"Add a retention class to a document manually","description":"Appends one class to a document (`document_retention_class`, source `manual`; ADR-0012 D4). Requires `retention.class.assign` (firm_admin or `manage` on the node); writes `retention.class_assigned`. Assignment is append-only: a class is removed only through an executed override (D6), so this operation never shortens a date. An already-assigned class answers 409 CONFLICT. Guests and support are refused with 403. The route lands in T-260914-2bc8.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"classId":{"type":"string","enum":["legal_file","legal_financial_record","legal_liability_long","wwft_cdd","mortgage_advice_file","mortgage_supporting","mortgage_identity_copy","general_room","notary_file","notary_environmental","accountancy_record","financial_advice_file","mifid_record","mediation_file","insolvency_estate"],"description":"Class to add; removal needs an override (ADR-0012 D6)."}},"required":["classId"],"additionalProperties":false,"description":"Add one class to a document manually."}}}},"responses":{"200":{"description":"The appended class assignment.","content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid","description":"Document id."},"classId":{"type":"string","enum":["legal_file","legal_financial_record","legal_liability_long","wwft_cdd","mortgage_advice_file","mortgage_supporting","mortgage_identity_copy","general_room","notary_file","notary_environmental","accountancy_record","financial_advice_file","mifid_record","mediation_file","insolvency_estate"],"description":"Platform retention class id (ADR-0012 D2); tenants cannot create classes in the MVP."},"source":{"type":"string","enum":["room_type","folder","document_type","condition","manual"],"description":"Source of a class assignment (ADR-0012 D4); assignment is append-only."},"assignedAt":{"type":"string","format":"date-time","description":"Assignment timestamp (UTC, ISO-8601)."},"assignedBy":{"type":"string","nullable":true,"format":"uuid","description":"Principal that assigned the class, or null for a rule."}},"required":["documentId","classId","source","assignedAt","assignedBy"],"additionalProperties":false,"description":"One class assignment on a document (ADR-0012 D4); append-only."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no retention right, or a guest/support session; guests and support never see retention or holds).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, or hidden from the caller; cross-tenant answers the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Conflict (code CONFLICT): the class is already assigned to the document.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/retention/overrides":{"post":{"operationId":"requestRetentionOverride","summary":"Request a retention override (shortening)","description":"Creates a deletion request of kind `retention_override` (ADR-0012 D6, D10) for a document, folder, room or matter: remove classes or set an explicit `retention_until`. Firm admins only, with step-up (`retention.override.request`); writes `deletion_request.created`. Never executes the deletion itself: an executed override then follows the normal expiry and trash path (D6). Refused with 409 LEGAL_HOLD when a covered item is on hold (at request, approval and execution), with 409 RETENTION_BELOW_MINIMUM when a resulting date drops below a class minimum without one of the four allowed reason codes, and with 409 REASON_NOT_ALLOWED for a reason code the case does not accept. Two approvals (or the cooling-off fallback) apply below a minimum, for room/matter scope and for the root or majority folder cases (D6); `approvalsRequired` reports which. Guests and support are refused with 403. The route lands in T-260914-2bc8.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"scope":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["document"]},"documentId":{"type":"string","format":"uuid","description":"Document id."},"roomId":{"type":"string","format":"uuid","description":"Room id."}},"required":["kind","documentId","roomId"],"additionalProperties":false,"description":"Override of one document."},{"type":"object","properties":{"kind":{"type":"string","enum":["index_node"]},"indexNodeId":{"type":"string","format":"uuid","description":"Folder whose subtree is overridden."},"roomId":{"type":"string","format":"uuid","description":"Room id."}},"required":["kind","indexNodeId","roomId"],"additionalProperties":false,"description":"Override of one folder and its subtree."},{"type":"object","properties":{"kind":{"type":"string","enum":["room"]},"roomId":{"type":"string","format":"uuid","description":"Room id."}},"required":["kind","roomId"],"additionalProperties":false,"description":"Override of one room."},{"type":"object","properties":{"kind":{"type":"string","enum":["matter"]},"matterId":{"type":"string","format":"uuid","description":"Matter id."}},"required":["kind","matterId"],"additionalProperties":false,"description":"Override of one matter."}]},"change":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["remove_classes"]},"classIds":{"type":"array","items":{"type":"string","enum":["legal_file","legal_financial_record","legal_liability_long","wwft_cdd","mortgage_advice_file","mortgage_supporting","mortgage_identity_copy","general_room","notary_file","notary_environmental","accountancy_record","financial_advice_file","mifid_record","mediation_file","insolvency_estate"],"description":"Platform retention class id (ADR-0012 D2); tenants cannot create classes in the MVP."},"minItems":1,"description":"Classes to remove."}},"required":["kind","classIds"],"additionalProperties":false,"description":"Remove classes from the scoped items."},{"type":"object","properties":{"kind":{"type":"string","enum":["set_until"]},"until":{"type":"string","format":"date","description":"Explicit new retention_until; never a date in the past (server-checked)."}},"required":["kind","until"],"additionalProperties":false,"description":"Set an explicit retention_until."}]},"reasonCode":{"type":"string","enum":["erasure_request_granted","uploaded_in_error","special_category_data","wrong_client","other"],"description":"Required; below a class minimum only the four ADR-0012 D6 codes are accepted."},"note":{"type":"string","minLength":1,"maxLength":2000,"description":"Free text; stored encrypted as a note row and never echoed by the API."}},"required":["scope","change","reasonCode"],"additionalProperties":false,"description":"Request a retention override; never executes the deletion itself (ADR-0012 D6)."}}}},"responses":{"200":{"description":"The deletion request created by the override (ids and codes only).","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Deletion request id."},"kind":{"type":"string","enum":["retention_override"],"description":"Deletion request kind (ADR-0012 D10)."},"status":{"type":"string","enum":["requested","approved","executing","completed","rejected","cancelled","expired","failed"],"description":"Status of the deletion request an override creates (ADR-0012 D10)."},"scopeKind":{"type":"string","enum":["document","index_node","room","matter"],"description":"Scope of a retention override request (ADR-0012 D6)."},"targetId":{"type":"string","format":"uuid","description":"Id of the scoped document, folder, room or matter."},"changeKind":{"type":"string","enum":["remove_classes","set_until"],"description":"Change an override requests (ADR-0012 D6)."},"reasonCode":{"type":"string","enum":["erasure_request_granted","uploaded_in_error","special_category_data","wrong_client","other"],"description":"Reason code of a retention override (ADR-0012 D6)."},"approvalsRequired":{"type":"integer","minimum":1,"maximum":2,"description":"1 or 2 (ADR-0012 D6)."},"requestedBy":{"type":"string","format":"uuid","description":"Requesting principal."},"requestedAt":{"type":"string","format":"date-time","description":"Request timestamp (UTC, ISO-8601)."},"expiresAt":{"type":"string","format":"date-time","description":"Request expiry (ADR-0012 D10)."}},"required":["id","kind","status","scopeKind","targetId","changeKind","reasonCode","approvalsRequired","requestedBy","requestedAt","expiresAt"],"additionalProperties":false,"description":"The deletion request created by a retention override (ids and codes only)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no retention right, or a guest/support session; guests and support never see retention or holds).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, or hidden from the caller; cross-tenant answers the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Conflict (code LEGAL_HOLD, RETENTION_BELOW_MINIMUM or REASON_NOT_ALLOWED): the override is blocked by a hold, below a class minimum, or carries a refused reason code.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/legal-holds":{"get":{"operationId":"listLegalHolds","summary":"List the legal holds of the tenant","description":"The holds of ADR-0012 D7, optionally filtered by scope, room, matter or document; `includeLifted=true` adds holds still inside their 7-day release grace. Requires `legal_hold.read` (firm_admin, compliance or `manage` holders of the room). Guests and support are refused with 403 and never see a hold or a hold badge. Ids, codes and dates only: no scope title, document name or note text. The route lands in T-260914-68dc.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","enum":["document","index_node","room","matter"],"description":"What a legal hold covers (ADR-0012 D7): a document, a folder subtree, a room or a matter."},"required":false,"description":"What a legal hold covers (ADR-0012 D7): a document, a folder subtree, a room or a matter.","name":"scopeKind","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":false,"description":"Room id.","name":"roomId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Matter id."},"required":false,"description":"Matter id.","name":"matterId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":false,"description":"Document id.","name":"documentId","in":"query"},{"schema":{"type":"string","enum":["true","false"],"description":"GET boolean wire form; include lifted holds (still in grace) when true."},"required":false,"description":"GET boolean wire form; include lifted holds (still in grace) when true.","name":"includeLifted","in":"query"}],"responses":{"200":{"description":"Holds of the tenant, newest first.","content":{"application/json":{"schema":{"type":"object","properties":{"holds":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Legal hold id."},"tenantId":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"scope":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["document"]},"documentId":{"type":"string","format":"uuid","description":"Document id."},"roomId":{"type":"string","format":"uuid","description":"Room id."}},"required":["kind","documentId","roomId"],"additionalProperties":false,"description":"A single document."},{"type":"object","properties":{"kind":{"type":"string","enum":["index_node"]},"indexNodeId":{"type":"string","format":"uuid","description":"Folder and its whole subtree, including documents moved in later."},"roomId":{"type":"string","format":"uuid","description":"Room id."}},"required":["kind","indexNodeId","roomId"],"additionalProperties":false,"description":"A folder and its subtree."},{"type":"object","properties":{"kind":{"type":"string","enum":["room"]},"roomId":{"type":"string","format":"uuid","description":"Room id."}},"required":["kind","roomId"],"additionalProperties":false,"description":"A room and its records."},{"type":"object","properties":{"kind":{"type":"string","enum":["matter"]},"matterId":{"type":"string","format":"uuid","description":"Matter id."}},"required":["kind","matterId"],"additionalProperties":false,"description":"Every room of a matter."}]},"status":{"type":"string","enum":["active","lifted"],"description":"Derived hold status (ADR-0012 D7); the grace period is a separate projection."},"reasonCode":{"type":"string","enum":["litigation_pending","litigation_expected","complaint","disciplinary","regulator_request","internal_investigation","client_instruction","other"],"description":"Reason code for placing a legal hold (ADR-0012 D7)."},"noteId":{"type":"string","nullable":true,"format":"uuid","description":"Encrypted note row id, or null; the text is never returned."},"placedBy":{"type":"string","format":"uuid","description":"Principal that placed the hold."},"placedAt":{"type":"string","format":"date-time","description":"Placement timestamp (UTC, ISO-8601)."},"liftedBy":{"type":"string","nullable":true,"format":"uuid","description":"Principal that lifted the hold, or null."},"liftedAt":{"type":"string","nullable":true,"format":"date-time","description":"Lift timestamp, or null while active."},"liftReasonCode":{"type":"string","nullable":true,"enum":["resolved","placed_in_error","regulator_released","client_instruction","other",null],"description":"Lift reason code, or null."},"liftNoteId":{"type":"string","nullable":true,"format":"uuid","description":"Encrypted lift-note row id, or null."},"graceEndsAt":{"type":"string","nullable":true,"format":"date-time","description":"End of the 7-day release grace after a lift, or null while active."},"graceActive":{"type":"boolean","description":"True while a lifted hold is still inside its grace period."}},"required":["id","tenantId","scope","status","reasonCode","noteId","placedBy","placedAt","liftedBy","liftedAt","liftReasonCode","liftNoteId","graceEndsAt","graceActive"],"additionalProperties":false,"description":"One legal hold; ids, codes and dates only (ADR-0012 D7)."},"description":"Holds of the tenant, newest first."}},"required":["holds"],"description":"Legal holds of one tenant; ids, codes and dates only."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no retention right, or a guest/support session; guests and support never see retention or holds).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, or hidden from the caller; cross-tenant answers the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"post":{"operationId":"placeLegalHold","summary":"Place a legal hold","description":"Places a hold on a document, folder (subtree), room or matter (RET-02, DOC-20, ADR-0012 D7). Allowed for `firm_admin`, `compliance` and internal principals with `manage` on the node or room (a matter hold also for the responsible lawyer), always with step-up (`legal_hold.place`); writes `legal_hold.placed`. The optional note is stored encrypted as a note row and never echoed. Refused with 409 ROOM_DESTROYING in a `destroying` or `destroyed` room; refused with 403 for guests and support, who never see a hold. A hold wins over every deletion path (D7). The route lands in T-260914-68dc.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"scope":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["document"]},"documentId":{"type":"string","format":"uuid","description":"Document id."},"roomId":{"type":"string","format":"uuid","description":"Room id."}},"required":["kind","documentId","roomId"],"additionalProperties":false,"description":"A single document."},{"type":"object","properties":{"kind":{"type":"string","enum":["index_node"]},"indexNodeId":{"type":"string","format":"uuid","description":"Folder and its whole subtree, including documents moved in later."},"roomId":{"type":"string","format":"uuid","description":"Room id."}},"required":["kind","indexNodeId","roomId"],"additionalProperties":false,"description":"A folder and its subtree."},{"type":"object","properties":{"kind":{"type":"string","enum":["room"]},"roomId":{"type":"string","format":"uuid","description":"Room id."}},"required":["kind","roomId"],"additionalProperties":false,"description":"A room and its records."},{"type":"object","properties":{"kind":{"type":"string","enum":["matter"]},"matterId":{"type":"string","format":"uuid","description":"Matter id."}},"required":["kind","matterId"],"additionalProperties":false,"description":"Every room of a matter."}]},"reasonCode":{"type":"string","enum":["litigation_pending","litigation_expected","complaint","disciplinary","regulator_request","internal_investigation","client_instruction","other"],"description":"Reason code for placing a legal hold (ADR-0012 D7)."},"note":{"type":"string","minLength":1,"maxLength":2000,"description":"Free text; stored encrypted as a note row and never echoed by the API."}},"required":["scope","reasonCode"],"additionalProperties":false,"description":"Place a legal hold on a document, folder, room or matter (RET-02)."}}}},"responses":{"200":{"description":"The placed hold.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Legal hold id."},"tenantId":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"scope":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["document"]},"documentId":{"type":"string","format":"uuid","description":"Document id."},"roomId":{"type":"string","format":"uuid","description":"Room id."}},"required":["kind","documentId","roomId"],"additionalProperties":false,"description":"A single document."},{"type":"object","properties":{"kind":{"type":"string","enum":["index_node"]},"indexNodeId":{"type":"string","format":"uuid","description":"Folder and its whole subtree, including documents moved in later."},"roomId":{"type":"string","format":"uuid","description":"Room id."}},"required":["kind","indexNodeId","roomId"],"additionalProperties":false,"description":"A folder and its subtree."},{"type":"object","properties":{"kind":{"type":"string","enum":["room"]},"roomId":{"type":"string","format":"uuid","description":"Room id."}},"required":["kind","roomId"],"additionalProperties":false,"description":"A room and its records."},{"type":"object","properties":{"kind":{"type":"string","enum":["matter"]},"matterId":{"type":"string","format":"uuid","description":"Matter id."}},"required":["kind","matterId"],"additionalProperties":false,"description":"Every room of a matter."}]},"status":{"type":"string","enum":["active","lifted"],"description":"Derived hold status (ADR-0012 D7); the grace period is a separate projection."},"reasonCode":{"type":"string","enum":["litigation_pending","litigation_expected","complaint","disciplinary","regulator_request","internal_investigation","client_instruction","other"],"description":"Reason code for placing a legal hold (ADR-0012 D7)."},"noteId":{"type":"string","nullable":true,"format":"uuid","description":"Encrypted note row id, or null; the text is never returned."},"placedBy":{"type":"string","format":"uuid","description":"Principal that placed the hold."},"placedAt":{"type":"string","format":"date-time","description":"Placement timestamp (UTC, ISO-8601)."},"liftedBy":{"type":"string","nullable":true,"format":"uuid","description":"Principal that lifted the hold, or null."},"liftedAt":{"type":"string","nullable":true,"format":"date-time","description":"Lift timestamp, or null while active."},"liftReasonCode":{"type":"string","nullable":true,"enum":["resolved","placed_in_error","regulator_released","client_instruction","other",null],"description":"Lift reason code, or null."},"liftNoteId":{"type":"string","nullable":true,"format":"uuid","description":"Encrypted lift-note row id, or null."},"graceEndsAt":{"type":"string","nullable":true,"format":"date-time","description":"End of the 7-day release grace after a lift, or null while active."},"graceActive":{"type":"boolean","description":"True while a lifted hold is still inside its grace period."}},"required":["id","tenantId","scope","status","reasonCode","noteId","placedBy","placedAt","liftedBy","liftedAt","liftReasonCode","liftNoteId","graceEndsAt","graceActive"],"additionalProperties":false,"description":"One legal hold; ids, codes and dates only (ADR-0012 D7)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no retention right, or a guest/support session; guests and support never see retention or holds).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, or hidden from the caller; cross-tenant answers the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Conflict (code ROOM_DESTROYING): the room is destroying or destroyed, so no hold can be placed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/legal-holds/{holdId}":{"get":{"operationId":"getLegalHold","summary":"Read one legal hold","description":"One hold with its scope, reason code, note id (never the text), placer and, after a lift, the lifter, the lift reason and the 7-day grace end (ADR-0012 D7). Requires `legal_hold.read`; guests and support are refused with 403. Ids, codes and dates only. The route lands in T-260914-68dc.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Legal hold id."},"required":true,"description":"Legal hold id.","name":"holdId","in":"path"}],"responses":{"200":{"description":"One legal hold.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Legal hold id."},"tenantId":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"scope":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["document"]},"documentId":{"type":"string","format":"uuid","description":"Document id."},"roomId":{"type":"string","format":"uuid","description":"Room id."}},"required":["kind","documentId","roomId"],"additionalProperties":false,"description":"A single document."},{"type":"object","properties":{"kind":{"type":"string","enum":["index_node"]},"indexNodeId":{"type":"string","format":"uuid","description":"Folder and its whole subtree, including documents moved in later."},"roomId":{"type":"string","format":"uuid","description":"Room id."}},"required":["kind","indexNodeId","roomId"],"additionalProperties":false,"description":"A folder and its subtree."},{"type":"object","properties":{"kind":{"type":"string","enum":["room"]},"roomId":{"type":"string","format":"uuid","description":"Room id."}},"required":["kind","roomId"],"additionalProperties":false,"description":"A room and its records."},{"type":"object","properties":{"kind":{"type":"string","enum":["matter"]},"matterId":{"type":"string","format":"uuid","description":"Matter id."}},"required":["kind","matterId"],"additionalProperties":false,"description":"Every room of a matter."}]},"status":{"type":"string","enum":["active","lifted"],"description":"Derived hold status (ADR-0012 D7); the grace period is a separate projection."},"reasonCode":{"type":"string","enum":["litigation_pending","litigation_expected","complaint","disciplinary","regulator_request","internal_investigation","client_instruction","other"],"description":"Reason code for placing a legal hold (ADR-0012 D7)."},"noteId":{"type":"string","nullable":true,"format":"uuid","description":"Encrypted note row id, or null; the text is never returned."},"placedBy":{"type":"string","format":"uuid","description":"Principal that placed the hold."},"placedAt":{"type":"string","format":"date-time","description":"Placement timestamp (UTC, ISO-8601)."},"liftedBy":{"type":"string","nullable":true,"format":"uuid","description":"Principal that lifted the hold, or null."},"liftedAt":{"type":"string","nullable":true,"format":"date-time","description":"Lift timestamp, or null while active."},"liftReasonCode":{"type":"string","nullable":true,"enum":["resolved","placed_in_error","regulator_released","client_instruction","other",null],"description":"Lift reason code, or null."},"liftNoteId":{"type":"string","nullable":true,"format":"uuid","description":"Encrypted lift-note row id, or null."},"graceEndsAt":{"type":"string","nullable":true,"format":"date-time","description":"End of the 7-day release grace after a lift, or null while active."},"graceActive":{"type":"boolean","description":"True while a lifted hold is still inside its grace period."}},"required":["id","tenantId","scope","status","reasonCode","noteId","placedBy","placedAt","liftedBy","liftedAt","liftReasonCode","liftNoteId","graceEndsAt","graceActive"],"additionalProperties":false,"description":"One legal hold; ids, codes and dates only (ADR-0012 D7)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no retention right, or a guest/support session; guests and support never see retention or holds).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, or hidden from the caller; cross-tenant answers the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/legal-holds/{holdId}/lift":{"post":{"operationId":"liftLegalHold","summary":"Lift a legal hold","description":"Lifts one hold with a reason code (ADR-0012 D7). Allowed for `firm_admin` and `compliance`, with step-up (`legal_hold.lift`); writes `legal_hold.lifted` and notifies the placer and every firm_admin/compliance principal (kind and link only). The item stays covered for the 7-day release grace (`DDR_HOLD_RELEASE_GRACE_DAYS`), so a mistaken lift is reversible; the response reports `graceEndsAt` and `graceActive`. Refused with 409 ROOM_DESTROYING in a `destroying` or `destroyed` room and with 403 for guests and support. `agreement_ended` is not accepted here: the termination contract release is an operations-tool action (D8.6). The route lands in T-260914-68dc.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Legal hold id."},"required":true,"description":"Legal hold id.","name":"holdId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["resolved","placed_in_error","regulator_released","client_instruction","other"],"description":"Reason code for lifting a legal hold; the termination contract release is ops-only."},"note":{"type":"string","minLength":1,"maxLength":2000,"description":"Free text; stored encrypted as a note row and never echoed by the API."}},"required":["reasonCode"],"additionalProperties":false,"description":"Lift a legal hold; the 7-day grace period then still blocks deletion."}}}},"responses":{"200":{"description":"The lifted hold with its grace end.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Legal hold id."},"tenantId":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"scope":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["document"]},"documentId":{"type":"string","format":"uuid","description":"Document id."},"roomId":{"type":"string","format":"uuid","description":"Room id."}},"required":["kind","documentId","roomId"],"additionalProperties":false,"description":"A single document."},{"type":"object","properties":{"kind":{"type":"string","enum":["index_node"]},"indexNodeId":{"type":"string","format":"uuid","description":"Folder and its whole subtree, including documents moved in later."},"roomId":{"type":"string","format":"uuid","description":"Room id."}},"required":["kind","indexNodeId","roomId"],"additionalProperties":false,"description":"A folder and its subtree."},{"type":"object","properties":{"kind":{"type":"string","enum":["room"]},"roomId":{"type":"string","format":"uuid","description":"Room id."}},"required":["kind","roomId"],"additionalProperties":false,"description":"A room and its records."},{"type":"object","properties":{"kind":{"type":"string","enum":["matter"]},"matterId":{"type":"string","format":"uuid","description":"Matter id."}},"required":["kind","matterId"],"additionalProperties":false,"description":"Every room of a matter."}]},"status":{"type":"string","enum":["active","lifted"],"description":"Derived hold status (ADR-0012 D7); the grace period is a separate projection."},"reasonCode":{"type":"string","enum":["litigation_pending","litigation_expected","complaint","disciplinary","regulator_request","internal_investigation","client_instruction","other"],"description":"Reason code for placing a legal hold (ADR-0012 D7)."},"noteId":{"type":"string","nullable":true,"format":"uuid","description":"Encrypted note row id, or null; the text is never returned."},"placedBy":{"type":"string","format":"uuid","description":"Principal that placed the hold."},"placedAt":{"type":"string","format":"date-time","description":"Placement timestamp (UTC, ISO-8601)."},"liftedBy":{"type":"string","nullable":true,"format":"uuid","description":"Principal that lifted the hold, or null."},"liftedAt":{"type":"string","nullable":true,"format":"date-time","description":"Lift timestamp, or null while active."},"liftReasonCode":{"type":"string","nullable":true,"enum":["resolved","placed_in_error","regulator_released","client_instruction","other",null],"description":"Lift reason code, or null."},"liftNoteId":{"type":"string","nullable":true,"format":"uuid","description":"Encrypted lift-note row id, or null."},"graceEndsAt":{"type":"string","nullable":true,"format":"date-time","description":"End of the 7-day release grace after a lift, or null while active."},"graceActive":{"type":"boolean","description":"True while a lifted hold is still inside its grace period."}},"required":["id","tenantId","scope","status","reasonCode","noteId","placedBy","placedAt","liftedBy","liftedAt","liftReasonCode","liftNoteId","graceEndsAt","graceActive"],"additionalProperties":false,"description":"One legal hold; ids, codes and dates only (ADR-0012 D7)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no retention right, or a guest/support session; guests and support never see retention or holds).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, or hidden from the caller; cross-tenant answers the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Conflict (code ROOM_DESTROYING): the room is destroying or destroyed, so no hold can be lifted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/storage/pool":{"get":{"operationId":"getStoragePool","summary":"Read the organisation storage pool","description":"The organisation-wide pool of ADR-0007 D10 in plaintext bytes: size, hot and archive usage, open reservations, remaining, the derived state (ok, warning at 80 %, grace, blocked) and the grace end (S-ADMIN-07, BILL-05). One pool per tenant and never a limit per user, room, matter or file. `state === \"blocked\"` means new uploads are refused with 409 STORAGE_POOL_EXHAUSTED while viewing, downloading and exporting keep working. Firm-admin read; the concrete policy action and its negative test land with T-260914-a684. 404 hides existence (including cross-tenant, PERM-02).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"The organisation storage pool.","content":{"application/json":{"schema":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"poolBytes":{"type":"integer","minimum":0,"description":"Contractual pool size in plaintext bytes (seats x allowance + extra blocks)."},"archiveAllowanceBytes":{"type":"integer","minimum":0,"description":"Archive allowance: 10 x poolBytes (ADR-0007 D10)."},"usedHotBytes":{"type":"integer","minimum":0,"description":"Billable hot bytes (tier hot/archiving/restoring, including trash and promoted renditions)."},"usedArchiveBytes":{"type":"integer","minimum":0,"description":"Billable archive bytes (tier archived)."},"reservedBytes":{"type":"integer","minimum":0,"description":"Open upload reservations; counted towards the limit and recomputed by usage-rollup."},"usageBytes":{"type":"integer","minimum":0,"description":"usedHotBytes + reservedBytes: the usage compared against poolBytes and the 110 % hard limit."},"remainingBytes":{"type":"integer","description":"poolBytes - usageBytes; negative during the grace period (ADR-0007 D10)."},"state":{"type":"string","enum":["ok","warning","grace","blocked"],"description":"Derived pool state (ADR-0007 D10): ok, warning at 80 %, grace, or blocked."},"graceEndsAt":{"type":"string","nullable":true,"format":"date-time","description":"When the grace period ends (overLimitSince + 30 days), or null outside grace/blocked."},"updatedAt":{"type":"string","format":"date-time","description":"Last change to the pool row."}},"required":["tenantId","poolBytes","archiveAllowanceBytes","usedHotBytes","usedArchiveBytes","reservedBytes","usageBytes","remainingBytes","state","graceEndsAt","updatedAt"],"description":"Organisation storage pool (BILL-05, DOC-23): one pool per tenant."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (not a firm admin).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/storage/usage":{"get":{"operationId":"listStorageUsage","summary":"List storage usage per client, matter or room","description":"Cursor-paginated usage rollup (DOC-23, S-ADMIN-07): originals split into current, noncurrent and trash bytes, archive bytes, the informational derivative bytes and the blob count, per client, matter or room. Rooms add up to the tenant, so client and matter totals are sums over their rooms. Only the firm-visible scope name is returned: never a document name, a file name or document content. Firm users see the scopes they may access; 404 hides a scope the caller may not see (including cross-tenant, PERM-02).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","enum":["client","matter","room"],"description":"Only rows of this scope kind."},"required":false,"description":"Only rows of this scope kind.","name":"kind","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Only rows under this client (drill-down)."},"required":false,"description":"Only rows under this client (drill-down).","name":"clientId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Only rows under this matter (drill-down)."},"required":false,"description":"Only rows under this matter (drill-down).","name":"matterId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Only the row of this room."},"required":false,"description":"Only the row of this room.","name":"roomId","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":512,"description":"Opaque cursor from the previous page; absent starts at the first page."},"required":false,"description":"Opaque cursor from the previous page; absent starts at the first page.","name":"cursor","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page size, 1-100 (default 50)."},"required":false,"description":"Page size, 1-100 (default 50).","name":"limit","in":"query"}],"responses":{"200":{"description":"One usage page.","content":{"application/json":{"schema":{"type":"object","properties":{"entries":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["client","matter","room"],"description":"Aggregation scope of a usage row (DOC-23): client, matter or room."},"id":{"type":"string","format":"uuid","description":"Id of the client, matter or room."},"clientId":{"type":"string","nullable":true,"format":"uuid","description":"Owning client; equal to id for kind client, null for a client-less scope."},"matterId":{"type":"string","nullable":true,"format":"uuid","description":"Owning matter; null for kind client."},"name":{"type":"string","nullable":true,"description":"Firm-visible scope name (client, matter or room). Never a document or file name."},"currentBytes":{"type":"integer","minimum":0,"description":"Blobs referenced by a current version."},"noncurrentBytes":{"type":"integer","minimum":0,"description":"Blobs referenced only by older versions."},"trashBytes":{"type":"integer","minimum":0,"description":"Blobs referenced only by trashed documents."},"archiveBytes":{"type":"integer","minimum":0,"description":"Blobs with tier archived."},"derivedCipherBytes":{"type":"integer","minimum":0,"description":"Derivatives, shown for information and never billed (ADR-0007 D10)."},"billableBytes":{"type":"integer","minimum":0,"description":"currentBytes + noncurrentBytes + trashBytes + archiveBytes; excludes derivatives."},"blobCount":{"type":"integer","minimum":0,"description":"Number of counted blobs in this scope."}},"required":["kind","id","clientId","matterId","name","currentBytes","noncurrentBytes","trashBytes","archiveBytes","derivedCipherBytes","billableBytes","blobCount"],"description":"Usage of one client, matter or room (DOC-23)."},"description":"Usage rows of the requested scope."},"nextCursor":{"type":"string","nullable":true,"description":"Opaque cursor for the next page, or null when this is the last page."},"asOf":{"type":"string","nullable":true,"format":"date","description":"Rollup day of storage_usage_daily, or null before the first rollup ran."}},"required":["entries","nextCursor","asOf"],"description":"Storage usage page (DOC-23)."}}}},"400":{"description":"Invalid filter or cursor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no access to the requested scope).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, or a scope the caller may not see (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/storage/pool/config":{"get":{"operationId":"getStoragePoolConfig","summary":"Read the organisation storage pool configuration","description":"The pool configuration of ADR-0007 D10 (PLAN §7.3): billable seats, allowance per seat, extra 100 GiB blocks, and the derived pool size and archive allowance. Configuration only, never a price or invoice (BILL-05 V1). Firm admins only with step-up (the tenant.settings.update action, ADR-0003 D5); 404 hides existence (including cross-tenant, PERM-02).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"The pool configuration.","content":{"application/json":{"schema":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"seats":{"type":"integer","minimum":0,"description":"Billable seats contributing to the pool."},"bytesPerSeat":{"type":"integer","minimum":0,"description":"Allowance per seat in plaintext bytes."},"extraBlocks":{"type":"integer","minimum":0,"description":"Extra storage blocks of extraBlockBytes."},"extraBlockBytes":{"type":"integer","minimum":0,"description":"Bytes per extra block (STORAGE_POOL_EXTRA_BLOCK_BYTES, 100 GiB)."},"poolBytes":{"type":"integer","minimum":0,"description":"Derived pool size: seats x bytesPerSeat + extraBlocks x extraBlockBytes."},"archiveAllowanceBytes":{"type":"integer","minimum":0,"description":"Derived archive allowance: 10 x poolBytes."},"updatedAt":{"type":"string","format":"date-time","description":"Last change to the configuration."}},"required":["tenantId","seats","bytesPerSeat","extraBlocks","extraBlockBytes","poolBytes","archiveAllowanceBytes","updatedAt"],"description":"Organisation storage pool configuration (config only, no billing)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (not a firm admin) or step-up required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"patch":{"operationId":"updateStoragePoolConfig","summary":"Update the organisation storage pool configuration","description":"Updates seats, allowance per seat and/or the extra 100 GiB blocks; the stored pool size is recomputed as seats x allowance + extra blocks and the archive allowance as 10 x that (ADR-0007 D10, PLAN §7.3). Configuration only, no billing. Firm admins only with step-up (tenant.settings.update, ADR-0003 D5). A shrink is never refused: it moves the grace clock like any plan change, so an upload is only ever refused by the pool limit with 409 STORAGE_POOL_EXHAUSTED. Emits tenant.settings_changed with setting_codes [\"storage_pool_config\"].","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"seats":{"type":"integer","minimum":0,"description":"New number of billable seats."},"bytesPerSeat":{"type":"integer","minimum":0,"description":"New allowance per seat in plaintext bytes."},"extraBlocks":{"type":"integer","minimum":0,"description":"New number of extra 100 GiB blocks."}},"description":"Update the organisation storage pool configuration."}}}},"responses":{"200":{"description":"The stored pool configuration after the change.","content":{"application/json":{"schema":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"seats":{"type":"integer","minimum":0,"description":"Billable seats contributing to the pool."},"bytesPerSeat":{"type":"integer","minimum":0,"description":"Allowance per seat in plaintext bytes."},"extraBlocks":{"type":"integer","minimum":0,"description":"Extra storage blocks of extraBlockBytes."},"extraBlockBytes":{"type":"integer","minimum":0,"description":"Bytes per extra block (STORAGE_POOL_EXTRA_BLOCK_BYTES, 100 GiB)."},"poolBytes":{"type":"integer","minimum":0,"description":"Derived pool size: seats x bytesPerSeat + extraBlocks x extraBlockBytes."},"archiveAllowanceBytes":{"type":"integer","minimum":0,"description":"Derived archive allowance: 10 x poolBytes."},"updatedAt":{"type":"string","format":"date-time","description":"Last change to the configuration."}},"required":["tenantId","seats","bytesPerSeat","extraBlocks","extraBlockBytes","poolBytes","archiveAllowanceBytes","updatedAt"],"description":"Organisation storage pool configuration (config only, no billing)."}}}},"400":{"description":"Invalid configuration (negative value, or an empty patch).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (not a firm admin) or step-up required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/me/notifications":{"get":{"operationId":"listNotifications","summary":"List my notifications with the unread count","description":"The notification centre of the signed-in principal (S-FIRM-08): one cursor-paginated page (unread first, then read, each newest first) plus the total unread count of the top-bar bell. Own data only; another tenant answers 404 (PERM-02). Every item is ids, the closed event type, closed codes, a count and read state: never a file name, document title, client name or content (INT-05, rule 1). The optional `labels` map names the ids on the page, resolved at read time for this reader through `@ddr/policy` (like the dashboard); nothing the reader may no longer see is named. Event types switched off in-app are not listed. Navigation read: no audit event (ADR-0006 D4).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","minLength":1,"maxLength":512,"description":"Opaque cursor from `nextCursor`; omit it for the newest page."},"required":false,"description":"Opaque cursor from `nextCursor`; omit it for the newest page.","name":"cursor","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page size (1..100, default 20)."},"required":false,"description":"Page size (1..100, default 20).","name":"limit","in":"query"}],"responses":{"200":{"description":"One page of the notification centre with the unread count.","content":{"application/json":{"schema":{"type":"object","properties":{"notifications":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Notification id."},"eventType":{"type":"string","enum":["new_upload","request_fulfilled","approval_needed","message","deadline","question_asked","question_answered","invitation_accepted","version_restored","bsn_flag","download_ready","signing_completed","recurring_request_sent","access_expired"],"description":"Notification kind (closed list; S-FIRM-08 groups by type, S-MAIL-04 counts per type)."},"createdAt":{"type":"string","format":"date-time","description":"When the event happened (UTC, ISO-8601)."},"readAt":{"type":"string","nullable":true,"format":"date-time","description":"When the principal marked it read; null while unread."},"target":{"type":"object","nullable":true,"properties":{"kind":{"type":"string","enum":["room","flow","document","message_thread","question","download_job"],"description":"Kind of the deep-link target."},"id":{"type":"string","format":"uuid","description":"Id of the target; the client resolves the display name itself."}},"required":["kind","id"],"additionalProperties":false,"description":"Where \"open\" goes; null for a notice without a single target."},"subjectCount":{"type":"integer","minimum":1,"description":"How many items this notification summarises; a count only (S-MAIL-04)."},"roomId":{"type":"string","nullable":true,"format":"uuid","description":"Room the event happened in (id only); null for a firm-level notice."},"actorId":{"type":"string","nullable":true,"format":"uuid","description":"Principal who caused the event (id only); null for the system (deadlines, detections)."},"deadlineKind":{"type":"string","nullable":true,"enum":["flow_due","financing_condition","binding_offer","notary","document_validity",null],"description":"Deadline kind: a request due date, a mortgage file date (financing condition, binding offer, notary), or a delivered document that expires (ADR-0053)."},"dueDate":{"type":"string","nullable":true,"format":"date","description":"Due date of a `deadline` notification (calendar date, Europe/Amsterdam)."}},"required":["id","eventType","createdAt","readAt","target","subjectCount"],"additionalProperties":false,"description":"One notification in the centre. Holds ids, the event type, closed codes, a date, a count and read state only: never a file name, document title, client name or content (INT-05, rule 1)."},"description":"Unread first, then read; each newest first."},"labels":{"type":"object","properties":{"rooms":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"description":"Room names by id, resolved at read time for this reader."},"documents":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"description":"Document titles by id, resolved at read time for this reader."},"principals":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"description":"Display names of actors by id, resolved at read time for this reader."},"flows":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"description":"Request titles by id, resolved at read time for this reader."},"questions":{"type":"object","additionalProperties":{"type":"object","properties":{"number":{"type":"integer","minimum":1,"description":"Question number within its bidder group."},"subject":{"type":"string","nullable":true,"maxLength":500,"description":"Subject, when the reader may see the question."}},"required":["number","subject"],"additionalProperties":false,"description":"Read-time label of a Q&A question."},"description":"Q&A questions by id, resolved at read time for this reader."}},"required":["rooms","documents","principals","flows","questions"],"additionalProperties":false,"description":"Read-time labels for the ids on one page of the centre (never stored with a notification)."},"unreadCount":{"type":"integer","minimum":0,"description":"Total unread notifications of the principal (the top-bar bell count, S-FIRM-08)."},"nextCursor":{"type":"string","nullable":true,"minLength":1,"maxLength":512,"description":"Cursor for the next page; null when this is the last page."}},"required":["notifications","unreadCount","nextCursor"],"additionalProperties":false,"description":"One page of the notification centre with the unread count."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, unknown or foreign notification (including cross-tenant), or the path is not registered yet (T-260914-0a87).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/me/notifications/{notificationId}/read":{"post":{"operationId":"markNotificationRead","summary":"Mark one notification read","description":"Marks the principal own notification read (S-FIRM-08) and answers the recalculated unread count. Idempotent when it was already read. A foreign or unknown notification is 404, never 403 (PERM-02). Own-data mutation: no audit event (ADR-0006 D4).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Notification id."},"required":true,"description":"Notification id.","name":"notificationId","in":"path"}],"responses":{"200":{"description":"The notification after the change with the recalculated unread count.","content":{"application/json":{"schema":{"type":"object","properties":{"notification":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Notification id."},"eventType":{"type":"string","enum":["new_upload","request_fulfilled","approval_needed","message","deadline","question_asked","question_answered","invitation_accepted","version_restored","bsn_flag","download_ready","signing_completed","recurring_request_sent","access_expired"],"description":"Notification kind (closed list; S-FIRM-08 groups by type, S-MAIL-04 counts per type)."},"createdAt":{"type":"string","format":"date-time","description":"When the event happened (UTC, ISO-8601)."},"readAt":{"type":"string","nullable":true,"format":"date-time","description":"When the principal marked it read; null while unread."},"target":{"type":"object","nullable":true,"properties":{"kind":{"type":"string","enum":["room","flow","document","message_thread","question","download_job"],"description":"Kind of the deep-link target."},"id":{"type":"string","format":"uuid","description":"Id of the target; the client resolves the display name itself."}},"required":["kind","id"],"additionalProperties":false,"description":"Where \"open\" goes; null for a notice without a single target."},"subjectCount":{"type":"integer","minimum":1,"description":"How many items this notification summarises; a count only (S-MAIL-04)."},"roomId":{"type":"string","nullable":true,"format":"uuid","description":"Room the event happened in (id only); null for a firm-level notice."},"actorId":{"type":"string","nullable":true,"format":"uuid","description":"Principal who caused the event (id only); null for the system (deadlines, detections)."},"deadlineKind":{"type":"string","nullable":true,"enum":["flow_due","financing_condition","binding_offer","notary","document_validity",null],"description":"Deadline kind: a request due date, a mortgage file date (financing condition, binding offer, notary), or a delivered document that expires (ADR-0053)."},"dueDate":{"type":"string","nullable":true,"format":"date","description":"Due date of a `deadline` notification (calendar date, Europe/Amsterdam)."}},"required":["id","eventType","createdAt","readAt","target","subjectCount"],"additionalProperties":false,"description":"The notification after the change (readAt is set)."},"unreadCount":{"type":"integer","minimum":0,"description":"Recalculated unread count."}},"required":["notification","unreadCount"],"additionalProperties":false,"description":"Result of marking one notification read; idempotent when it was already read."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, unknown or foreign notification (including cross-tenant), or the path is not registered yet (T-260914-0a87).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/me/notifications/read-all":{"post":{"operationId":"markAllNotificationsRead","summary":"Mark all my notifications read","description":"Marks every notification of the principal read (S-FIRM-08 \"Mark all as read\") and answers how many changed plus the now-zero unread count. Idempotent. Own-data mutation: no audit event (ADR-0006 D4).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"How many notifications were marked read; the unread count is zero.","content":{"application/json":{"schema":{"type":"object","properties":{"markedRead":{"type":"integer","minimum":0,"description":"How many notifications changed from unread to read."},"unreadCount":{"type":"number","enum":[0],"description":"Always 0 after \"Mark all as read\" (S-FIRM-08)."}},"required":["markedRead","unreadCount"],"additionalProperties":false,"description":"Result of marking every notification read; idempotent."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, unknown or foreign notification (including cross-tenant), or the path is not registered yet (T-260914-0a87).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/me/notification-preferences/events":{"get":{"operationId":"getNotificationEventPreferences","summary":"Read my per-event notification preferences","description":"The fine-grained layer of S-FIRM-08: one e-mail frequency per closed event type (INT-05). It extends the coarse account preferences of T-260916-61fc (`/me/notification-preferences`), reusing the same `immediately | daily | weekly | never` vocabulary. Own data only; another tenant answers 404. Navigation read: no audit event (ADR-0006 D4).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"My per-event preferences; every event type appears exactly once.","content":{"application/json":{"schema":{"type":"object","properties":{"preferences":{"type":"array","items":{"type":"object","properties":{"eventType":{"type":"string","enum":["new_upload","request_fulfilled","approval_needed","message","deadline","question_asked","question_answered","invitation_accepted","version_restored","bsn_flag","download_ready","signing_completed","recurring_request_sent","access_expired"],"description":"Notification kind (closed list; S-FIRM-08 groups by type, S-MAIL-04 counts per type)."},"frequency":{"type":"string","enum":["immediately","daily","weekly","never"],"description":"E-mail frequency for this event type (INT-05)."},"inApp":{"type":"boolean","default":true,"description":"Show this event type in the in-app centre and the bell (default true). False with frequency `never` switches the type off."}},"required":["eventType","frequency"],"additionalProperties":false,"description":"One event type's in-app switch and e-mail delivery frequency."},"description":"One entry per event type (new_upload, request_fulfilled, approval_needed, message, deadline, question_asked, question_answered, invitation_accepted, version_restored, bsn_flag, download_ready, signing_completed, recurring_request_sent, access_expired), each exactly once."}},"required":["preferences"],"additionalProperties":false,"description":"Per-principal e-mail frequency per event type (INT-05). Every closed event type appears exactly once; unknown keys are rejected."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, unknown or foreign notification (including cross-tenant), or the path is not registered yet (T-260914-0a87).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"put":{"operationId":"putNotificationEventPreferences","summary":"Replace my per-event notification preferences","description":"Full replace of the per-event e-mail preferences (INT-05). Strict: the frequency is the closed enum and every closed event type must appear exactly once, so a missing type cannot silently fall back to a default the user never chose. E-mails name the firm and a count only, never item titles, file names or client names (S-MAIL-04, rule 1). Own-data mutation: no audit event (ADR-0006 D4).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"preferences":{"type":"array","items":{"type":"object","properties":{"eventType":{"type":"string","enum":["new_upload","request_fulfilled","approval_needed","message","deadline","question_asked","question_answered","invitation_accepted","version_restored","bsn_flag","download_ready","signing_completed","recurring_request_sent","access_expired"],"description":"Notification kind (closed list; S-FIRM-08 groups by type, S-MAIL-04 counts per type)."},"frequency":{"type":"string","enum":["immediately","daily","weekly","never"],"description":"E-mail frequency for this event type (INT-05)."},"inApp":{"type":"boolean","default":true,"description":"Show this event type in the in-app centre and the bell (default true). False with frequency `never` switches the type off."}},"required":["eventType","frequency"],"additionalProperties":false,"description":"One event type's in-app switch and e-mail delivery frequency."},"description":"One entry per event type (new_upload, request_fulfilled, approval_needed, message, deadline, question_asked, question_answered, invitation_accepted, version_restored, bsn_flag, download_ready, signing_completed, recurring_request_sent, access_expired), each exactly once."}},"required":["preferences"],"additionalProperties":false,"description":"Replace my per-event notification preferences (full document; every event type exactly once)."}}}},"responses":{"200":{"description":"Stored per-event preferences.","content":{"application/json":{"schema":{"type":"object","properties":{"preferences":{"type":"array","items":{"type":"object","properties":{"eventType":{"type":"string","enum":["new_upload","request_fulfilled","approval_needed","message","deadline","question_asked","question_answered","invitation_accepted","version_restored","bsn_flag","download_ready","signing_completed","recurring_request_sent","access_expired"],"description":"Notification kind (closed list; S-FIRM-08 groups by type, S-MAIL-04 counts per type)."},"frequency":{"type":"string","enum":["immediately","daily","weekly","never"],"description":"E-mail frequency for this event type (INT-05)."},"inApp":{"type":"boolean","default":true,"description":"Show this event type in the in-app centre and the bell (default true). False with frequency `never` switches the type off."}},"required":["eventType","frequency"],"additionalProperties":false,"description":"One event type's in-app switch and e-mail delivery frequency."},"description":"One entry per event type (new_upload, request_fulfilled, approval_needed, message, deadline, question_asked, question_answered, invitation_accepted, version_restored, bsn_flag, download_ready, signing_completed, recurring_request_sent, access_expired), each exactly once."}},"required":["preferences"],"additionalProperties":false,"description":"Per-principal e-mail frequency per event type (INT-05). Every closed event type appears exactly once; unknown keys are rejected."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, unknown or foreign notification (including cross-tenant), or the path is not registered yet (T-260914-0a87).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/me/notifications/stream":{"get":{"operationId":"streamNotifications","summary":"Live notification stream (SSE) for signed-in users","description":"Server-Sent Events stream of new notifications for the signed-in principal (INT-06), backed by PostgreSQL LISTEN/NOTIFY on the server side. Each frame is newline-delimited JSON with `event` (`notification`, `unread` with the live bell count, or `heartbeat`) and `id` as the resume cursor; a reconnect may pass the last id as `Last-Event-ID` or as `cursor`. A notification frame carries the same content-free payload as the centre list; a heartbeat keeps a proxy from closing an idle stream. Own data only; another tenant answers 404. Continuously-read stream: no audit event (ADR-0006 D4).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","minLength":1,"maxLength":512,"description":"Resume cursor; an EventSource normally sends it as Last-Event-ID."},"required":false,"description":"Resume cursor; an EventSource normally sends it as Last-Event-ID.","name":"cursor","in":"query"}],"responses":{"200":{"description":"The event stream; frames are newline-delimited JSON.","content":{"text/event-stream":{"schema":{"oneOf":[{"type":"object","properties":{"event":{"type":"string","enum":["notification"]},"id":{"type":"string","minLength":1,"maxLength":512,"description":"Opaque cursor from `nextCursor`; omit it for the newest page."},"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Notification id."},"eventType":{"type":"string","enum":["new_upload","request_fulfilled","approval_needed","message","deadline","question_asked","question_answered","invitation_accepted","version_restored","bsn_flag","download_ready","signing_completed","recurring_request_sent","access_expired"],"description":"Notification kind (closed list; S-FIRM-08 groups by type, S-MAIL-04 counts per type)."},"createdAt":{"type":"string","format":"date-time","description":"When the event happened (UTC, ISO-8601)."},"readAt":{"type":"string","nullable":true,"format":"date-time","description":"When the principal marked it read; null while unread."},"target":{"type":"object","nullable":true,"properties":{"kind":{"type":"string","enum":["room","flow","document","message_thread","question","download_job"],"description":"Kind of the deep-link target."},"id":{"type":"string","format":"uuid","description":"Id of the target; the client resolves the display name itself."}},"required":["kind","id"],"additionalProperties":false,"description":"Where \"open\" goes; null for a notice without a single target."},"subjectCount":{"type":"integer","minimum":1,"description":"How many items this notification summarises; a count only (S-MAIL-04)."},"roomId":{"type":"string","nullable":true,"format":"uuid","description":"Room the event happened in (id only); null for a firm-level notice."},"actorId":{"type":"string","nullable":true,"format":"uuid","description":"Principal who caused the event (id only); null for the system (deadlines, detections)."},"deadlineKind":{"type":"string","nullable":true,"enum":["flow_due","financing_condition","binding_offer","notary","document_validity",null],"description":"Deadline kind: a request due date, a mortgage file date (financing condition, binding offer, notary), or a delivered document that expires (ADR-0053)."},"dueDate":{"type":"string","nullable":true,"format":"date","description":"Due date of a `deadline` notification (calendar date, Europe/Amsterdam)."}},"required":["id","eventType","createdAt","readAt","target","subjectCount"],"additionalProperties":false,"description":"One notification in the centre. Holds ids, the event type, closed codes, a date, a count and read state only: never a file name, document title, client name or content (INT-05, rule 1)."}},"required":["event","id","data"],"additionalProperties":false},{"type":"object","properties":{"event":{"type":"string","enum":["unread"]},"id":{"type":"string","minLength":1,"maxLength":512,"description":"Opaque cursor from `nextCursor`; omit it for the newest page."},"data":{"type":"object","properties":{"unreadCount":{"type":"integer","minimum":0,"description":"Current unread count of the principal."}},"required":["unreadCount"],"additionalProperties":false,"description":"Unread-count frame body of the notification stream (the top-bar bell)."}},"required":["event","id","data"],"additionalProperties":false},{"type":"object","properties":{"event":{"type":"string","enum":["heartbeat"]},"id":{"type":"string","minLength":1,"maxLength":512,"description":"Opaque cursor from `nextCursor`; omit it for the newest page."},"data":{"type":"object","properties":{"at":{"type":"string","format":"date-time","description":"Heartbeat timestamp (UTC, ISO-8601)."}},"required":["at"],"additionalProperties":false,"description":"Keep-alive frame body of the notification stream."}},"required":["event","id","data"],"additionalProperties":false}],"description":"One SSE frame of the notification stream (INT-06). `id` is the resume cursor, `event` is the closed frame name (`notification`, `unread`, `heartbeat`) and `data` is the content-free payload; frames never carry labels."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, unknown or foreign notification (including cross-tenant), or the path is not registered yet (T-260914-0a87).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/metadata":{"get":{"operationId":"getDocumentMetadata","summary":"Read document metadata","description":"Basic DOC-11 metadata of one document (tags, language, document date, document type; S-ROOM-04). Requires `document.view`; 404 hides existence (including cross-tenant, PERM-02). Metadata is client data: the body carries ids, closed codes and dates only, never content, a snippet, a file name or a BSN. The privileged flag is part of the firm-user projection; a guest receives the same metadata **without** the privileged flag and never learns whether a document is privileged. The route is registered by T-260914-247b; until then an unmatched request answers the framework 404.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"}],"responses":{"200":{"description":"Metadata visible to the caller (privileged only for firm users; guests get the projection without it).","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"documentId":{"type":"string","format":"uuid","description":"Document id."},"roomId":{"type":"string","format":"uuid","description":"Room that owns the document."},"tags":{"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"description":"Document tag filter value (DOC-11); client data, never logged."},"maxItems":20,"description":"Professional labels on the document; client data, never logged (DOC-11 \"Tags\")."},"language":{"type":"string","enum":["nl","en","other"],"description":"Document language, the closed SRCH-04 set (DOC-11 \"Language\")."},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Calendar date the document is dated (day precision, DOC-11 \"Date\"); null when unknown."},"documentType":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Shared E20 document-type id (searchDocumentTypeSchema, DOC-11 \"Document type\"); one list for search, flows and metadata."},"privileged":{"type":"boolean","description":"Privileged (\"geheimhoudingsplicht\") marker; shown as a header badge (DOC-11, S-ROOM-04). Never sent to guests."}},"required":["documentId","roomId","tags","language","documentDate","documentType","privileged"],"additionalProperties":false,"description":"Document metadata projection for a firm user (DOC-11 basic MVP, S-ROOM-04)."},{"type":"object","properties":{"documentId":{"type":"string","format":"uuid","description":"Document id."},"roomId":{"type":"string","format":"uuid","description":"Room that owns the document."},"tags":{"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"description":"Document tag filter value (DOC-11); client data, never logged."},"maxItems":20,"description":"Professional labels on the document; client data, never logged (DOC-11 \"Tags\")."},"language":{"type":"string","enum":["nl","en","other"],"description":"Document language, the closed SRCH-04 set (DOC-11 \"Language\")."},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Calendar date the document is dated (day precision, DOC-11 \"Date\"); null when unknown."},"documentType":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Shared E20 document-type id (searchDocumentTypeSchema, DOC-11 \"Document type\"); one list for search, flows and metadata."}},"required":["documentId","roomId","tags","language","documentDate","documentType"],"additionalProperties":false,"description":"Document metadata projection for a guest: never carries the privileged flag (DOC-11)."}],"description":"Document metadata visible to the caller (privileged only for firm users, DOC-11)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"The document (or room) does not exist or is not visible to the caller (code NOT_FOUND, ADR-0005 §8, PERM-02). Guest existence is hidden the same way.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"patch":{"operationId":"updateDocumentMetadata","summary":"Edit document metadata","description":"Partially edits the basic DOC-11 metadata (tags, language, document date, document type, privileged; S-ROOM-04). Requires `document.edit`; guests can never edit metadata, so the 200 is the firm-user projection (with privileged). Values are validated against the shared SRCH-04 schemas, so an unknown document type or a language outside `nl`/`en`/`other` is refused. Writes a `document.metadata_changed` audit event (T-260914-247b). The route is registered by T-260914-247b; until then an unmatched request answers the framework 404.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"description":"Document tag filter value (DOC-11); client data, never logged."},"maxItems":20,"description":"Replaces the tag list; an empty array clears every tag (DOC-11 \"Tags\")."},"language":{"type":"string","enum":["nl","en","other"],"description":"Document language; the closed SRCH-04 set."},"documentDate":{"type":"string","nullable":true,"format":"date","description":"New calendar date (day precision); null clears the date (DOC-11 \"Date\")."},"documentType":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Shared E20 document-type id (DOC-11 \"Document type\")."},"privileged":{"type":"boolean","description":"Set or clear the privileged marker; only internal users may edit it (DOC-11)."}},"additionalProperties":false,"description":"Partial document metadata edit (DOC-11 basic MVP); unknown keys are refused."}}}},"responses":{"200":{"description":"Stored metadata (firm-user projection).","content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid","description":"Document id."},"roomId":{"type":"string","format":"uuid","description":"Room that owns the document."},"tags":{"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"description":"Document tag filter value (DOC-11); client data, never logged."},"maxItems":20,"description":"Professional labels on the document; client data, never logged (DOC-11 \"Tags\")."},"language":{"type":"string","enum":["nl","en","other"],"description":"Document language, the closed SRCH-04 set (DOC-11 \"Language\")."},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Calendar date the document is dated (day precision, DOC-11 \"Date\"); null when unknown."},"documentType":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Shared E20 document-type id (searchDocumentTypeSchema, DOC-11 \"Document type\"); one list for search, flows and metadata."},"privileged":{"type":"boolean","description":"Privileged (\"geheimhoudingsplicht\") marker; shown as a header badge (DOC-11, S-ROOM-04). Never sent to guests."}},"required":["documentId","roomId","tags","language","documentDate","documentType","privileged"],"additionalProperties":false,"description":"Document metadata projection for a firm user (DOC-11 basic MVP, S-ROOM-04)."}}}},"400":{"description":"Invalid request (code BAD_REQUEST): an empty edit, an unknown key, a malformed document date, or a tag or language outside the shared closed set.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: the caller may view the document but lacks `document.edit`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"The document (or room) does not exist or is not visible to the caller (code NOT_FOUND, ADR-0005 §8, PERM-02). Guest existence is hidden the same way.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Conflict (code CONFLICT): the edited type or date is well-formed but refused for this document (for example a document date in the future), or the document is not editable in its current state (frozen room, legal hold). No metadata is changed; the handler checks authorization before this.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/uploads":{"post":{"operationId":"uploadDocument","summary":"Upload one file into the room index","description":"One file per request as the raw body (application/octet-stream, at most 100 MiB). Requires `document.upload` (write level `upload_with_approval` or higher) on the target folder, the parent of a target placeholder, or the room root. The server encrypts the bytes with a fresh DEK under the room key, stores the ciphertext in quarantine (never overwriting), and creates the document, its first version (status `scanning`), the blob and the processing steps in one transaction with the `document_version.uploaded` audit event. A placeholder target becomes the document node. The file name is client data: it is stored in the version row only and never reaches logs, object keys or audit details.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","minLength":1,"maxLength":1024,"description":"The file name, percent-encoded (encodeURIComponent). Client data: never logged."},"required":true,"description":"The file name, percent-encoded (encodeURIComponent). Client data: never logged.","name":"x-ddr-filename","in":"header"},{"schema":{"type":"string","pattern":"^\\d{1,15}$","description":"Declared size in bytes; must equal the body length when present."},"required":false,"description":"Declared size in bytes; must equal the body length when present.","name":"x-ddr-size","in":"header"},{"schema":{"type":"string","format":"uuid","description":"Target folder, or a placeholder the file fulfils; omitted means the room root."},"required":false,"description":"Target folder, or a placeholder the file fulfils; omitted means the room root.","name":"x-ddr-index-node-id","in":"header"},{"schema":{"type":"string","maxLength":4096,"description":"Percent-encoded folder chain below the target (`a/b`), created as folders when missing (folder uploads)."},"required":false,"description":"Percent-encoded folder chain below the target (`a/b`), created as folders when missing (folder uploads).","name":"x-ddr-relative-path","in":"header"}],"requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string","description":"The raw file bytes."}}}},"responses":{"201":{"description":"Stored; the version is being scanned.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The index node of the uploaded document."},"documentId":{"type":"string","format":"uuid","description":"The document."},"versionId":{"type":"string","format":"uuid","description":"The new document version."},"versionNo":{"type":"integer","minimum":1,"description":"Version number (1 for a new document)."},"status":{"type":"string","enum":["uploading","scanning","available","rejected","failed"],"description":"Version status right after the upload (normally `scanning`)."}},"required":["id","documentId","versionId","versionNo","status"],"description":"Created document version."}}}},"400":{"description":"Missing or invalid headers, or a size mismatch.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no upload level on the target).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or an invisible target).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Read-only room.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"413":{"description":"Too large, or the storage pool is exhausted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}":{"get":{"operationId":"getRoomDocument","summary":"Read one document and its latest version","description":"Name, media type, size, version and pipeline status of a document for the viewer header. A PDF-only caller (`sourceAccess: pdf_only`) is told the PDF rendition’s name and media type and no size. Requires `node.read` on the document node; a pending (not yet available) version is visible to its uploader and to managers only. 404 hides existence (including cross-tenant, PERM-02).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"}],"responses":{"200":{"description":"The document.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Document id."},"roomId":{"type":"string","format":"uuid"},"indexNodeId":{"type":"string","nullable":true,"format":"uuid","description":"The index node that shows this document."},"name":{"type":"string","nullable":true,"description":"Original file name of the latest version (client data)."},"mimeType":{"type":"string","nullable":true,"description":"Declared media type of the latest version."},"sizeBytes":{"type":"integer","nullable":true,"minimum":0,"description":"Plaintext size of the latest version."},"versionId":{"type":"string","format":"uuid","description":"Latest version."},"versionNo":{"type":"integer","minimum":1},"status":{"type":"string","enum":["uploading","scanning","available","rejected","failed"],"description":"Pipeline status of the current version (ADR-0007 D3)."},"uploadedAt":{"type":"string","format":"date-time"},"availableAt":{"type":"string","nullable":true,"format":"date-time"},"pageCount":{"type":"integer","nullable":true,"minimum":1,"description":"Page count once the converter has run; null until then."},"sourceAccess":{"type":"string","enum":["source","pdf_only"],"description":"Absent = `source`. `pdf_only`: `name` ends in `.pdf`, `mimeType` is `application/pdf` and `sizeBytes` is null; the viewer shows the pages, never the spreadsheet cell grid."}},"required":["id","roomId","indexNodeId","name","mimeType","sizeBytes","versionId","versionNo","status","uploadedAt","availableAt","pageCount"],"description":"One document of a room with its latest version (viewer header)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/approve":{"post":{"operationId":"approveRoomDocument","summary":"Approve a document uploaded with approval","description":"ADR-0026: a document uploaded by someone whose level on the folder is `upload_with_approval` waits for a `manage` holder; until then only the uploader and managers see it. Requires `upload.approve` on the document (managers, never guests). A document without a pending version answers 409. Writes document_version.approved.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"}],"responses":{"200":{"description":"Approved: the document is visible to everyone with access to its folder.","content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid"},"versionId":{"type":"string","format":"uuid","description":"The approved version."},"approvalPending":{"type":"boolean","enum":[false]}},"required":["documentId","versionId","approvalPending"],"additionalProperties":false,"description":"The document no longer waits for approval."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `manage` on the document).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"CONFLICT: nothing waits for approval.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/reject":{"post":{"operationId":"rejectRoomDocument","summary":"Reject a document uploaded with approval","description":"ADR-0026 (T-260914-7723): a document uploaded by someone whose level on the folder is `upload_with_approval` waits for a `manage` holder; until then only the uploader and managers see it. Requires `upload.approve` on the document (managers, never guests). The pending version becomes `rejected` and is never visible to other groups. A document without a pending version answers 409. Writes document_version.rejected.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":1,"maxLength":500,"description":"Why the pending version is sent back (manager note, synthetic data only)."}},"additionalProperties":false,"description":"Reject a document that waits for approval."}}}},"responses":{"200":{"description":"Rejected: the version is rejected and no longer waits for approval.","content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid"},"versionId":{"type":"string","format":"uuid","description":"The rejected version."},"approvalPending":{"type":"boolean","enum":[false]}},"required":["documentId","versionId","approvalPending"],"additionalProperties":false,"description":"The document no longer waits for approval; the version is rejected."}}}},"400":{"description":"Invalid reason.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `manage` on the document).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"CONFLICT: nothing waits for approval.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/versions":{"get":{"operationId":"listDocumentVersions","summary":"List the versions of a document","description":"Newest first: number, uploader, date, size, fingerprint prefix, status and the current flag. A PDF-only caller (`sourceAccess: pdf_only`) gets each version’s PDF rendition name and media type, without size or fingerprint. Requires `node.read` on the document node (the same metadata level as `getRoomDocument`); versions that are not available yet are listed only for their uploader and managers. 404 hides existence (including cross-tenant, PERM-02).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"}],"responses":{"200":{"description":"The version history.","content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid"},"currentVersionNo":{"type":"integer","nullable":true,"minimum":1,"description":"Null until a version is available."},"versions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Version id."},"documentId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":1,"description":"1-based version number."},"reason":{"type":"string","enum":["upload","replace","restore","redaction","signed"],"description":"Why the version exists (ADR-0007 D3; `signed` is the signed PDF of a signing request, ADR-0055)."},"restoredFromVersionNo":{"type":"integer","nullable":true,"minimum":1,"description":"The version this one restores; null unless `reason` is `restore`."},"name":{"type":"string","nullable":true,"description":"Original file name of this version (client data)."},"mimeType":{"type":"string","nullable":true},"sizeBytes":{"type":"integer","nullable":true,"minimum":0,"description":"Plaintext size; null while unknown."},"sha256Prefix":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{12}$","description":"First 12 hex characters of the plaintext SHA-256 (fingerprint); null while unknown."},"identicalContent":{"type":"object","properties":{"total":{"type":"integer","minimum":0,"description":"How many other visible documents in this room hold the same bytes."},"documents":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true,"description":"That document’s current file name (client data)."}},"required":["documentId","name"],"additionalProperties":false,"description":"Another document in this room whose source bytes are identical."},"maxItems":10,"description":"At most 10 of them; `total` stays the real count."}},"default":{"total":0,"documents":[]},"required":["total","documents"],"additionalProperties":false,"description":"Other documents in this room with byte-identical source content (DOC-24). Empty for a PDF-only caller and while the version has no blob yet; absent reads as empty, so an older client is never told there are duplicates when the set is simply missing."},"status":{"type":"string","enum":["uploading","scanning","available","rejected","failed"],"description":"Pipeline status of the current version (ADR-0007 D3)."},"uploadedBy":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"displayName":{"type":"string","nullable":true,"description":"Profile display name; null when none is recorded."}},"required":["id","displayName"],"description":"Who created the version."},"uploadedAt":{"type":"string","format":"date-time"},"availableAt":{"type":"string","nullable":true,"format":"date-time"},"isCurrent":{"type":"boolean","description":"Whether this is the document’s current (served) version."},"internalOnly":{"type":"boolean","description":"An earlier version of a redacted document (RED-02, ADR-0040): firm users only, never listed for guests. Absent means false."}},"required":["id","documentId","versionNo","reason","restoredFromVersionNo","name","mimeType","sizeBytes","sha256Prefix","status","uploadedBy","uploadedAt","availableAt","isCurrent"],"description":"One immutable version of a document."},"description":"Newest first."},"sourceAccess":{"type":"string","enum":["source","pdf_only"],"description":"Absent = `source`. `pdf_only`: every version names its PDF rendition, with no size, fingerprint or same-content set of the source."}},"required":["documentId","currentVersionNo","versions"],"description":"Version history of one document."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"post":{"operationId":"uploadDocumentVersion","summary":"Upload a new version of a document","description":"One file per request as the raw body (same headers as `uploadDocument`; `x-ddr-index-node-id` and `x-ddr-relative-path` are ignored). Requires `document.version.create` (write level `edit`) on the document node. Adds version n+1 (`reason = replace`, status `scanning`) with a fresh blob and quarantine object; previous versions and their objects are never touched. The document’s current version moves when the new version is promoted. Writes `document_version.uploaded` with `reason = replace`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"},{"schema":{"type":"string","minLength":1,"maxLength":1024,"description":"The file name, percent-encoded (encodeURIComponent). Client data: never logged."},"required":true,"description":"The file name, percent-encoded (encodeURIComponent). Client data: never logged.","name":"x-ddr-filename","in":"header"},{"schema":{"type":"string","pattern":"^\\d{1,15}$","description":"Declared size in bytes; must equal the body length when present."},"required":false,"description":"Declared size in bytes; must equal the body length when present.","name":"x-ddr-size","in":"header"},{"schema":{"type":"string","format":"uuid","description":"Target folder, or a placeholder the file fulfils; omitted means the room root."},"required":false,"description":"Target folder, or a placeholder the file fulfils; omitted means the room root.","name":"x-ddr-index-node-id","in":"header"},{"schema":{"type":"string","maxLength":4096,"description":"Percent-encoded folder chain below the target (`a/b`), created as folders when missing (folder uploads)."},"required":false,"description":"Percent-encoded folder chain below the target (`a/b`), created as folders when missing (folder uploads).","name":"x-ddr-relative-path","in":"header"}],"requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string","description":"The raw file bytes."}}}},"responses":{"201":{"description":"Stored; the new version is being scanned.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The index node of the uploaded document."},"documentId":{"type":"string","format":"uuid","description":"The document."},"versionId":{"type":"string","format":"uuid","description":"The new document version."},"versionNo":{"type":"integer","minimum":1,"description":"Version number (1 for a new document)."},"status":{"type":"string","enum":["uploading","scanning","available","rejected","failed"],"description":"Version status right after the upload (normally `scanning`)."}},"required":["id","documentId","versionId","versionNo","status"],"description":"Created document version."}}}},"400":{"description":"Missing or invalid headers, or a size mismatch.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no edit level on the document).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or an invisible document).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Read-only room.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"413":{"description":"Too large, or the storage pool is exhausted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/versions/{versionNo}":{"get":{"operationId":"getDocumentVersion","summary":"Read one version of a document","description":"Metadata of one version; same authorization and visibility as `listDocumentVersions`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"},{"schema":{"type":"string","pattern":"^[1-9][0-9]{0,8}$","description":"1-based version number."},"required":true,"description":"1-based version number.","name":"versionNo","in":"path"}],"responses":{"200":{"description":"The version.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Version id."},"documentId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":1,"description":"1-based version number."},"reason":{"type":"string","enum":["upload","replace","restore","redaction","signed"],"description":"Why the version exists (ADR-0007 D3; `signed` is the signed PDF of a signing request, ADR-0055)."},"restoredFromVersionNo":{"type":"integer","nullable":true,"minimum":1,"description":"The version this one restores; null unless `reason` is `restore`."},"name":{"type":"string","nullable":true,"description":"Original file name of this version (client data)."},"mimeType":{"type":"string","nullable":true},"sizeBytes":{"type":"integer","nullable":true,"minimum":0,"description":"Plaintext size; null while unknown."},"sha256Prefix":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{12}$","description":"First 12 hex characters of the plaintext SHA-256 (fingerprint); null while unknown."},"identicalContent":{"type":"object","properties":{"total":{"type":"integer","minimum":0,"description":"How many other visible documents in this room hold the same bytes."},"documents":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true,"description":"That document’s current file name (client data)."}},"required":["documentId","name"],"additionalProperties":false,"description":"Another document in this room whose source bytes are identical."},"maxItems":10,"description":"At most 10 of them; `total` stays the real count."}},"default":{"total":0,"documents":[]},"required":["total","documents"],"additionalProperties":false,"description":"Other documents in this room with byte-identical source content (DOC-24). Empty for a PDF-only caller and while the version has no blob yet; absent reads as empty, so an older client is never told there are duplicates when the set is simply missing."},"status":{"type":"string","enum":["uploading","scanning","available","rejected","failed"],"description":"Pipeline status of the current version (ADR-0007 D3)."},"uploadedBy":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"displayName":{"type":"string","nullable":true,"description":"Profile display name; null when none is recorded."}},"required":["id","displayName"],"description":"Who created the version."},"uploadedAt":{"type":"string","format":"date-time"},"availableAt":{"type":"string","nullable":true,"format":"date-time"},"isCurrent":{"type":"boolean","description":"Whether this is the document’s current (served) version."},"internalOnly":{"type":"boolean","description":"An earlier version of a redacted document (RED-02, ADR-0040): firm users only, never listed for guests. Absent means false."}},"required":["id","documentId","versionNo","reason","restoredFromVersionNo","name","mimeType","sizeBytes","sha256Prefix","status","uploadedBy","uploadedAt","availableAt","isCurrent"],"description":"One immutable version of a document."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/versions/{versionNo}/restore":{"post":{"operationId":"restoreDocumentVersion","summary":"Restore an older version as a new version","description":"Requires `document.version.create` (write level `edit`) on the document node. Adds version n+1 with `reason = restore` that points at the blob of the restored version (no copy, no overwrite; blob refcount + 1) and makes it current in the same transaction. Writes `document_version.restored`. 409 CONFLICT when the version is already current or not available; 409 SOURCE_UNAVAILABLE when its content is archived or destroyed.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"},{"schema":{"type":"string","pattern":"^[1-9][0-9]{0,8}$","description":"1-based version number."},"required":true,"description":"1-based version number.","name":"versionNo","in":"path"}],"responses":{"201":{"description":"The new (restored) version, now current.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Version id."},"documentId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":1,"description":"1-based version number."},"reason":{"type":"string","enum":["upload","replace","restore","redaction","signed"],"description":"Why the version exists (ADR-0007 D3; `signed` is the signed PDF of a signing request, ADR-0055)."},"restoredFromVersionNo":{"type":"integer","nullable":true,"minimum":1,"description":"The version this one restores; null unless `reason` is `restore`."},"name":{"type":"string","nullable":true,"description":"Original file name of this version (client data)."},"mimeType":{"type":"string","nullable":true},"sizeBytes":{"type":"integer","nullable":true,"minimum":0,"description":"Plaintext size; null while unknown."},"sha256Prefix":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{12}$","description":"First 12 hex characters of the plaintext SHA-256 (fingerprint); null while unknown."},"identicalContent":{"type":"object","properties":{"total":{"type":"integer","minimum":0,"description":"How many other visible documents in this room hold the same bytes."},"documents":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true,"description":"That document’s current file name (client data)."}},"required":["documentId","name"],"additionalProperties":false,"description":"Another document in this room whose source bytes are identical."},"maxItems":10,"description":"At most 10 of them; `total` stays the real count."}},"default":{"total":0,"documents":[]},"required":["total","documents"],"additionalProperties":false,"description":"Other documents in this room with byte-identical source content (DOC-24). Empty for a PDF-only caller and while the version has no blob yet; absent reads as empty, so an older client is never told there are duplicates when the set is simply missing."},"status":{"type":"string","enum":["uploading","scanning","available","rejected","failed"],"description":"Pipeline status of the current version (ADR-0007 D3)."},"uploadedBy":{"type":"object","properties":{"id":{"type":"string","nullable":true,"format":"uuid"},"displayName":{"type":"string","nullable":true,"description":"Profile display name; null when none is recorded."}},"required":["id","displayName"],"description":"Who created the version."},"uploadedAt":{"type":"string","format":"date-time"},"availableAt":{"type":"string","nullable":true,"format":"date-time"},"isCurrent":{"type":"boolean","description":"Whether this is the document’s current (served) version."},"internalOnly":{"type":"boolean","description":"An earlier version of a redacted document (RED-02, ADR-0040): firm users only, never listed for guests. Absent means false."}},"required":["id","documentId","versionNo","reason","restoredFromVersionNo","name","mimeType","sizeBytes","sha256Prefix","status","uploadedBy","uploadedAt","availableAt","isCurrent"],"description":"One immutable version of a document."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no edit level on the document).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Already current, not available, or read-only room.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/flows/{flowId}/items/{itemId}/questions":{"post":{"operationId":"askFlowItemQuestion","summary":"Post a professional message on an item question thread","description":"Adds a message to the per-item thread the client sees in the portal (request-flow profile). Requires flow_item.review on the item (manage, users only); 404 hides the item. Writes message.posted (ids only).","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":4000}},"required":["body"],"additionalProperties":false,"description":"One message on the item question thread."}}}},"responses":{"201":{"description":"Updated request.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"templateId":{"type":"string","nullable":true,"maxLength":100},"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipient":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"email":{"type":"string","maxLength":320,"format":"email"}},"required":["name","email"],"description":"The one person a request is addressed to (client data)."},"portalUrl":{"type":"string","nullable":true,"description":"Always null on the real stack: the link token is only ever in the request e-mail."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group bound to the party; null until the firm binds it."}},"required":["slot","label","groupId"],"additionalProperties":false,"description":"Room-bound party of a request (WF01): applicant slot, display label, room group."},"description":"Named room parties of this request (WF01); empty on legacy rows without a scope."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): bound parties share drafts. False keeps slot-private answers."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance. Null on legacy rows without a period."},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."},"targetFolderId":{"type":"string","nullable":true,"format":"uuid","description":"Room-index folder the approved files go into; null = root."},"targetFolderTitle":{"type":"string","nullable":true},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"overdue":{"type":"boolean"},"authStrength":{"type":"string","nullable":true,"enum":["single","mfa",null],"description":"Strength of the client session that submitted the item (ADR-0013 D1 condition 1)."},"bsnAutoMask":{"type":"boolean","description":"The worker burns every BSN out of a delivered file before approval (ADR-0053)."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number","targetFolderId","targetFolderTitle","submittedAt","overdue","authStrength"],"description":"Request item as the firm sees it."}},"createdAt":{"type":"string","format":"date-time"},"sentAt":{"type":"string","nullable":true,"format":"date-time"},"openedAt":{"type":"string","nullable":true,"format":"date-time"},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"reminders":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"description":"Reminders sent so far (automatic and manual)."},"lastAt":{"type":"string","nullable":true,"format":"date-time"},"nextAt":{"type":"string","nullable":true,"format":"date-time","description":"Next automatic reminder; null when none is due."},"paused":{"type":"boolean"}},"required":["count","lastAt","nextAt","paused"],"description":"Reminder state (ADR-0053)."}},"required":["id","roomId","templateId","title","message","status","dueDate","recipient","portalUrl","parties","joint","periodContext","expiresAt","coverInstructions","displayStatus","progress","sections","items","createdAt","sentAt","openedAt","submittedAt","completedAt","updatedAt"],"description":"Document request (request-flow profile, firm view)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no manage on the item).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, request or item.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/portal/requests/{token}":{"get":{"operationId":"getPortalRequest","summary":"Read a request in the client portal","description":"The request of the link token for its recipient. Without a guest session of the recipient the answer is 401 (UNAUTHENTICATED without a session, EMAIL_CODE_REQUIRED with another one): the link is never a credential (ADR-0003 D6); the portal signs in with the same token through requestGuestCode and signInWithGuestCode. Requires flow_item.read (single strength) per item; the first read of a session writes flow.link_opened.","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Link token from the request e-mail. Never a credential on its own."},"required":true,"description":"Link token from the request e-mail. Never a credential on its own.","name":"token","in":"path"}],"responses":{"200":{"description":"The request.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipientName":{"type":"string"},"applicantSlot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"The applicant slot this guest link is bound to (M2/HYP-03). Absent on a legacy single-recipient link, where the guest may fill every slot; present on a shared request, where the view carries only this slot’s private files and answers."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."}},"required":["slot","label"],"additionalProperties":false},"description":"Named room parties of this request (WF01): slot and display label only, so a party learns no internal group id. Empty on legacy rows."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): this portal shares every bound slot’s drafts. False keeps the slot-private view."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance (ids and period keys only). Null on legacy rows without a period."},"firm":{"type":"object","properties":{"name":{"type":"string"},"initials":{"type":"string","maxLength":4},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Vertical of the firm that owns the request (ADR-0030); drives the mortgage upload notices."},"logoUrl":{"type":"string","maxLength":300,"description":"Same-origin URL of the firm logo (public branding asset), when the firm set one."}},"required":["name","initials"]},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"claimReceipt":{"type":"object","properties":{"status":{"type":"string","enum":["not_submitted","received","correction_requested","under_review"],"description":"Guest-safe creditor claim status (WF04); never an internal acceptance or ranking."},"reference":{"type":"string","nullable":true,"maxLength":100,"description":"The creditor's own claim reference, echoed back; null until it is filed."},"itemCount":{"type":"integer","minimum":0,"description":"Items of the claim request."},"submittedCount":{"type":"integer","minimum":0,"description":"Items delivered so far."},"correctionCount":{"type":"integer","minimum":0,"description":"Items the firm sent back for correction."},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"First/last submit time of the claim; null when none."}},"required":["status","reference","itemCount","submittedCount","correctionCount","submittedAt"],"additionalProperties":false,"description":"Own receipt and guest-safe status of a creditor claim (WF04); present on insolvency creditor requests, absent elsewhere. Never carries another creditor data."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number"],"description":"Request item as the client sees it."}}},"required":["title","message","status","dueDate","recipientName","parties","joint","periodContext","firm","submittedAt","expiresAt","coverInstructions","displayStatus","progress","sections","items"],"description":"Document request in the client portal."}}}},"401":{"description":"Sign in with the e-mail code first.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown, expired or closed link.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/portal/requests/{token}/items/{itemId}/files":{"post":{"operationId":"uploadPortalFile","summary":"Upload a file into a request item (draft)","description":"The raw file (application/octet-stream, at most 100 MiB) with its name percent-encoded in x-ddr-filename. Requires flow_item.submit on the item (single strength, ADR-0013 D1) and an open item. The server encrypts the bytes under the room key in the guest intake transaction (ADR-0025), stores them in quarantine for the scan and keeps them out of the room index until the firm approves. Writes document_version.uploaded as the guest.","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Link token from the request e-mail. Never a credential on its own."},"required":true,"description":"Link token from the request e-mail. Never a credential on its own.","name":"token","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"},{"schema":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot filing this file; defaults to `applicant_1` (unknown slots are 400)."},"required":false,"description":"Applicant slot filing this file; defaults to `applicant_1` (unknown slots are 400).","name":"slot","in":"query"}],"requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string","description":"The raw file bytes."}}}},"responses":{"201":{"description":"Updated request.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipientName":{"type":"string"},"applicantSlot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"The applicant slot this guest link is bound to (M2/HYP-03). Absent on a legacy single-recipient link, where the guest may fill every slot; present on a shared request, where the view carries only this slot’s private files and answers."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."}},"required":["slot","label"],"additionalProperties":false},"description":"Named room parties of this request (WF01): slot and display label only, so a party learns no internal group id. Empty on legacy rows."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): this portal shares every bound slot’s drafts. False keeps the slot-private view."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance (ids and period keys only). Null on legacy rows without a period."},"firm":{"type":"object","properties":{"name":{"type":"string"},"initials":{"type":"string","maxLength":4},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Vertical of the firm that owns the request (ADR-0030); drives the mortgage upload notices."},"logoUrl":{"type":"string","maxLength":300,"description":"Same-origin URL of the firm logo (public branding asset), when the firm set one."}},"required":["name","initials"]},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"claimReceipt":{"type":"object","properties":{"status":{"type":"string","enum":["not_submitted","received","correction_requested","under_review"],"description":"Guest-safe creditor claim status (WF04); never an internal acceptance or ranking."},"reference":{"type":"string","nullable":true,"maxLength":100,"description":"The creditor's own claim reference, echoed back; null until it is filed."},"itemCount":{"type":"integer","minimum":0,"description":"Items of the claim request."},"submittedCount":{"type":"integer","minimum":0,"description":"Items delivered so far."},"correctionCount":{"type":"integer","minimum":0,"description":"Items the firm sent back for correction."},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"First/last submit time of the claim; null when none."}},"required":["status","reference","itemCount","submittedCount","correctionCount","submittedAt"],"additionalProperties":false,"description":"Own receipt and guest-safe status of a creditor claim (WF04); present on insolvency creditor requests, absent elsewhere. Never carries another creditor data."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number"],"description":"Request item as the client sees it."}}},"required":["title","message","status","dueDate","recipientName","parties","joint","periodContext","firm","submittedAt","expiresAt","coverInstructions","displayStatus","progress","sections","items"],"description":"Document request in the client portal."}}}},"400":{"description":"Missing file name, empty body or unknown applicant slot.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Sign in with the e-mail code first.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown link or item.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"ITEM_NOT_OPEN.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"413":{"description":"STORAGE_POOL_EXHAUSTED or too large.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/portal/requests/{token}/items/{itemId}/files/{fileId}":{"delete":{"operationId":"removePortalFile","summary":"Remove an own draft file","description":"Removes a file that was not sent yet from the item (the stored version stays until the purge path). Requires flow_item.submit. Writes flow_item.draft_file_removed.","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Link token from the request e-mail. Never a credential on its own."},"required":true,"description":"Link token from the request e-mail. Never a credential on its own.","name":"token","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"fileId","in":"path"},{"schema":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot filing this file; defaults to `applicant_1` (unknown slots are 400)."},"required":false,"description":"Applicant slot filing this file; defaults to `applicant_1` (unknown slots are 400).","name":"slot","in":"query"}],"responses":{"200":{"description":"Updated request.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipientName":{"type":"string"},"applicantSlot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"The applicant slot this guest link is bound to (M2/HYP-03). Absent on a legacy single-recipient link, where the guest may fill every slot; present on a shared request, where the view carries only this slot’s private files and answers."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."}},"required":["slot","label"],"additionalProperties":false},"description":"Named room parties of this request (WF01): slot and display label only, so a party learns no internal group id. Empty on legacy rows."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): this portal shares every bound slot’s drafts. False keeps the slot-private view."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance (ids and period keys only). Null on legacy rows without a period."},"firm":{"type":"object","properties":{"name":{"type":"string"},"initials":{"type":"string","maxLength":4},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Vertical of the firm that owns the request (ADR-0030); drives the mortgage upload notices."},"logoUrl":{"type":"string","maxLength":300,"description":"Same-origin URL of the firm logo (public branding asset), when the firm set one."}},"required":["name","initials"]},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"claimReceipt":{"type":"object","properties":{"status":{"type":"string","enum":["not_submitted","received","correction_requested","under_review"],"description":"Guest-safe creditor claim status (WF04); never an internal acceptance or ranking."},"reference":{"type":"string","nullable":true,"maxLength":100,"description":"The creditor's own claim reference, echoed back; null until it is filed."},"itemCount":{"type":"integer","minimum":0,"description":"Items of the claim request."},"submittedCount":{"type":"integer","minimum":0,"description":"Items delivered so far."},"correctionCount":{"type":"integer","minimum":0,"description":"Items the firm sent back for correction."},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"First/last submit time of the claim; null when none."}},"required":["status","reference","itemCount","submittedCount","correctionCount","submittedAt"],"additionalProperties":false,"description":"Own receipt and guest-safe status of a creditor claim (WF04); present on insolvency creditor requests, absent elsewhere. Never carries another creditor data."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number"],"description":"Request item as the client sees it."}}},"required":["title","message","status","dueDate","recipientName","parties","joint","periodContext","firm","submittedAt","expiresAt","coverInstructions","displayStatus","progress","sections","items"],"description":"Document request in the client portal."}}}},"400":{"description":"Unknown applicant slot.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Sign in with the e-mail code first.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown link, item or draft file.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"ITEM_NOT_OPEN.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/portal/requests/{token}/items/{itemId}/not-applicable":{"put":{"operationId":"markPortalNotApplicable","summary":"Mark an item not applicable (draft)","description":"Records the not-applicable claim with a reason code (`other` requires a note) as a draft until the request is sent; removes draft files of the item. Requires flow_item.respond (single strength). Unaudited draft: the send writes flow_item.submitted with kind not_applicable.","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Link token from the request e-mail. Never a credential on its own."},"required":true,"description":"Link token from the request e-mail. Never a credential on its own.","name":"token","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000}},"required":["reasonCode","note"],"additionalProperties":false,"description":"Mark an item not applicable (a draft until the client sends the request)."}}}},"responses":{"200":{"description":"Updated request.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipientName":{"type":"string"},"applicantSlot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"The applicant slot this guest link is bound to (M2/HYP-03). Absent on a legacy single-recipient link, where the guest may fill every slot; present on a shared request, where the view carries only this slot’s private files and answers."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."}},"required":["slot","label"],"additionalProperties":false},"description":"Named room parties of this request (WF01): slot and display label only, so a party learns no internal group id. Empty on legacy rows."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): this portal shares every bound slot’s drafts. False keeps the slot-private view."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance (ids and period keys only). Null on legacy rows without a period."},"firm":{"type":"object","properties":{"name":{"type":"string"},"initials":{"type":"string","maxLength":4},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Vertical of the firm that owns the request (ADR-0030); drives the mortgage upload notices."},"logoUrl":{"type":"string","maxLength":300,"description":"Same-origin URL of the firm logo (public branding asset), when the firm set one."}},"required":["name","initials"]},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"claimReceipt":{"type":"object","properties":{"status":{"type":"string","enum":["not_submitted","received","correction_requested","under_review"],"description":"Guest-safe creditor claim status (WF04); never an internal acceptance or ranking."},"reference":{"type":"string","nullable":true,"maxLength":100,"description":"The creditor's own claim reference, echoed back; null until it is filed."},"itemCount":{"type":"integer","minimum":0,"description":"Items of the claim request."},"submittedCount":{"type":"integer","minimum":0,"description":"Items delivered so far."},"correctionCount":{"type":"integer","minimum":0,"description":"Items the firm sent back for correction."},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"First/last submit time of the claim; null when none."}},"required":["status","reference","itemCount","submittedCount","correctionCount","submittedAt"],"additionalProperties":false,"description":"Own receipt and guest-safe status of a creditor claim (WF04); present on insolvency creditor requests, absent elsewhere. Never carries another creditor data."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number"],"description":"Request item as the client sees it."}}},"required":["title","message","status","dueDate","recipientName","parties","joint","periodContext","firm","submittedAt","expiresAt","coverInstructions","displayStatus","progress","sections","items"],"description":"Document request in the client portal."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Sign in with the e-mail code first.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown link or item.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"ITEM_NOT_OPEN.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"delete":{"operationId":"clearPortalNotApplicable","summary":"Withdraw a draft not-applicable claim","description":"Requires flow_item.respond on an open item.","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Link token from the request e-mail. Never a credential on its own."},"required":true,"description":"Link token from the request e-mail. Never a credential on its own.","name":"token","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"}],"responses":{"200":{"description":"Updated request.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipientName":{"type":"string"},"applicantSlot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"The applicant slot this guest link is bound to (M2/HYP-03). Absent on a legacy single-recipient link, where the guest may fill every slot; present on a shared request, where the view carries only this slot’s private files and answers."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."}},"required":["slot","label"],"additionalProperties":false},"description":"Named room parties of this request (WF01): slot and display label only, so a party learns no internal group id. Empty on legacy rows."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): this portal shares every bound slot’s drafts. False keeps the slot-private view."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance (ids and period keys only). Null on legacy rows without a period."},"firm":{"type":"object","properties":{"name":{"type":"string"},"initials":{"type":"string","maxLength":4},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Vertical of the firm that owns the request (ADR-0030); drives the mortgage upload notices."},"logoUrl":{"type":"string","maxLength":300,"description":"Same-origin URL of the firm logo (public branding asset), when the firm set one."}},"required":["name","initials"]},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"claimReceipt":{"type":"object","properties":{"status":{"type":"string","enum":["not_submitted","received","correction_requested","under_review"],"description":"Guest-safe creditor claim status (WF04); never an internal acceptance or ranking."},"reference":{"type":"string","nullable":true,"maxLength":100,"description":"The creditor's own claim reference, echoed back; null until it is filed."},"itemCount":{"type":"integer","minimum":0,"description":"Items of the claim request."},"submittedCount":{"type":"integer","minimum":0,"description":"Items delivered so far."},"correctionCount":{"type":"integer","minimum":0,"description":"Items the firm sent back for correction."},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"First/last submit time of the claim; null when none."}},"required":["status","reference","itemCount","submittedCount","correctionCount","submittedAt"],"additionalProperties":false,"description":"Own receipt and guest-safe status of a creditor claim (WF04); present on insolvency creditor requests, absent elsewhere. Never carries another creditor data."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number"],"description":"Request item as the client sees it."}}},"required":["title","message","status","dueDate","recipientName","parties","joint","periodContext","firm","submittedAt","expiresAt","coverInstructions","displayStatus","progress","sections","items"],"description":"Document request in the client portal."}}}},"401":{"description":"Sign in with the e-mail code first.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown link or item.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"ITEM_NOT_OPEN.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/portal/requests/{token}/items/{itemId}/questions":{"post":{"operationId":"askPortalQuestion","summary":"Ask the firm a question about an item","description":"Requires flow_item.respond (single strength). Writes message.posted (ids only).","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Link token from the request e-mail. Never a credential on its own."},"required":true,"description":"Link token from the request e-mail. Never a credential on its own.","name":"token","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":4000}},"required":["body"],"additionalProperties":false,"description":"One message on the item question thread."}}}},"responses":{"201":{"description":"Updated request.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipientName":{"type":"string"},"applicantSlot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"The applicant slot this guest link is bound to (M2/HYP-03). Absent on a legacy single-recipient link, where the guest may fill every slot; present on a shared request, where the view carries only this slot’s private files and answers."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."}},"required":["slot","label"],"additionalProperties":false},"description":"Named room parties of this request (WF01): slot and display label only, so a party learns no internal group id. Empty on legacy rows."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): this portal shares every bound slot’s drafts. False keeps the slot-private view."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance (ids and period keys only). Null on legacy rows without a period."},"firm":{"type":"object","properties":{"name":{"type":"string"},"initials":{"type":"string","maxLength":4},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Vertical of the firm that owns the request (ADR-0030); drives the mortgage upload notices."},"logoUrl":{"type":"string","maxLength":300,"description":"Same-origin URL of the firm logo (public branding asset), when the firm set one."}},"required":["name","initials"]},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"claimReceipt":{"type":"object","properties":{"status":{"type":"string","enum":["not_submitted","received","correction_requested","under_review"],"description":"Guest-safe creditor claim status (WF04); never an internal acceptance or ranking."},"reference":{"type":"string","nullable":true,"maxLength":100,"description":"The creditor's own claim reference, echoed back; null until it is filed."},"itemCount":{"type":"integer","minimum":0,"description":"Items of the claim request."},"submittedCount":{"type":"integer","minimum":0,"description":"Items delivered so far."},"correctionCount":{"type":"integer","minimum":0,"description":"Items the firm sent back for correction."},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"First/last submit time of the claim; null when none."}},"required":["status","reference","itemCount","submittedCount","correctionCount","submittedAt"],"additionalProperties":false,"description":"Own receipt and guest-safe status of a creditor claim (WF04); present on insolvency creditor requests, absent elsewhere. Never carries another creditor data."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number"],"description":"Request item as the client sees it."}}},"required":["title","message","status","dueDate","recipientName","parties","joint","periodContext","firm","submittedAt","expiresAt","coverInstructions","displayStatus","progress","sections","items"],"description":"Document request in the client portal."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Sign in with the e-mail code first.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown link or item.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/portal/requests/{token}/submit":{"post":{"operationId":"submitPortalRequest","summary":"Send the prepared items to the firm","description":"Sends every open item with draft files or a draft not-applicable claim in one transaction: files become submitted, the item waits for review. Requires flow_item.submit or flow_item.respond per item. Writes flow_item.submitted per item with the session strength (ADR-0013 D1 condition 1). 409 NOTHING_TO_SUBMIT when nothing is prepared.","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Link token from the request e-mail. Never a credential on its own."},"required":true,"description":"Link token from the request e-mail. Never a credential on its own.","name":"token","in":"path"}],"responses":{"200":{"description":"Updated request with the number of items sent.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipientName":{"type":"string"},"applicantSlot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"The applicant slot this guest link is bound to (M2/HYP-03). Absent on a legacy single-recipient link, where the guest may fill every slot; present on a shared request, where the view carries only this slot’s private files and answers."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."}},"required":["slot","label"],"additionalProperties":false},"description":"Named room parties of this request (WF01): slot and display label only, so a party learns no internal group id. Empty on legacy rows."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): this portal shares every bound slot’s drafts. False keeps the slot-private view."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance (ids and period keys only). Null on legacy rows without a period."},"firm":{"type":"object","properties":{"name":{"type":"string"},"initials":{"type":"string","maxLength":4},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Vertical of the firm that owns the request (ADR-0030); drives the mortgage upload notices."},"logoUrl":{"type":"string","maxLength":300,"description":"Same-origin URL of the firm logo (public branding asset), when the firm set one."}},"required":["name","initials"]},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"claimReceipt":{"type":"object","properties":{"status":{"type":"string","enum":["not_submitted","received","correction_requested","under_review"],"description":"Guest-safe creditor claim status (WF04); never an internal acceptance or ranking."},"reference":{"type":"string","nullable":true,"maxLength":100,"description":"The creditor's own claim reference, echoed back; null until it is filed."},"itemCount":{"type":"integer","minimum":0,"description":"Items of the claim request."},"submittedCount":{"type":"integer","minimum":0,"description":"Items delivered so far."},"correctionCount":{"type":"integer","minimum":0,"description":"Items the firm sent back for correction."},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"First/last submit time of the claim; null when none."}},"required":["status","reference","itemCount","submittedCount","correctionCount","submittedAt"],"additionalProperties":false,"description":"Own receipt and guest-safe status of a creditor claim (WF04); present on insolvency creditor requests, absent elsewhere. Never carries another creditor data."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number"],"description":"Request item as the client sees it."}},"submittedCount":{"type":"integer","minimum":1}},"required":["title","message","status","dueDate","recipientName","parties","joint","periodContext","firm","submittedAt","expiresAt","coverInstructions","displayStatus","progress","sections","items","submittedCount"],"description":"Portal view after sending, with the number of items sent."}}}},"401":{"description":"Sign in with the e-mail code first.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown link.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"NOTHING_TO_SUBMIT.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/dashboard":{"get":{"operationId":"getFirmDashboard","summary":"Read the firm home dashboard summary","description":"Composed summary for the signed-in firm user: readable rooms with document count, storage, last activity and request progress (`flow.read`: member rooms, or compliance), requests waiting for review and open requests due soon (`flow.read`), weekly KPI trends, recent activity from the audit trail of the rooms the caller may audit (`audit.read_room`; ids and codes plus names resolved at read time, ADR-0006 D10) and the organisation storage pool for firm-wide readers (`room.directory.read`). Firm users only (`tenant.profile.read`); a guest or a principal of another tenant gets 404 NOT_FOUND (PERM-02).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"The dashboard summary.","content":{"application/json":{"schema":{"type":"object","properties":{"viewer":{"type":"object","properties":{"principalId":{"type":"string","format":"uuid"},"displayName":{"type":"string","nullable":true,"description":"Display name of the signed-in firm user."}},"required":["principalId","displayName"],"description":"The caller."},"generatedAt":{"type":"string","format":"date-time"},"totals":{"type":"object","properties":{"activeRooms":{"type":"integer","minimum":0},"roomsCreatedThisWeek":{"type":"integer","minimum":0},"toReview":{"type":"integer","minimum":0,"description":"Submitted items waiting for review, across the readable rooms."},"reviewFlows":{"type":"integer","minimum":0,"description":"Requests those items belong to."},"uploadsThisWeek":{"type":"integer","minimum":0,"description":"Document versions uploaded in the last 7 days."},"uploadsLastWeek":{"type":"integer","minimum":0,"description":"Document versions uploaded 7 to 14 days ago."},"dueSoon":{"type":"integer","minimum":0,"description":"Open requests due within 30 days or overdue."},"overdue":{"type":"integer","minimum":0,"description":"Open requests whose due date passed."}},"required":["activeRooms","roomsCreatedThisWeek","toReview","reviewFlows","uploadsThisWeek","uploadsLastWeek","dueSoon","overdue"],"description":"KPI counters."},"trends":{"type":"object","properties":{"activity":{"type":"array","items":{"type":"integer","minimum":0},"description":"Audit events per week in the readable trails."},"submissions":{"type":"array","items":{"type":"integer","minimum":0},"description":"Items submitted per week."},"uploads":{"type":"array","items":{"type":"integer","minimum":0},"description":"Document versions uploaded per week."},"dues":{"type":"array","items":{"type":"integer","minimum":0},"description":"Open-request due dates per week (the last bucket is the coming week)."}},"required":["activity","submissions","uploads","dues"],"description":"Weekly counts, 8 buckets, oldest first."},"rooms":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","description":"Room name (firm-visible organisation metadata)."},"type":{"type":"string","description":"Room type code."},"packId":{"type":"string","nullable":true,"description":"Current immutable dossier pack; absent on legacy servers."},"sectorProfileId":{"type":"string","nullable":true,"description":"Sector profile of that dossier pack."},"edition":{"type":"string","enum":["general","transaction","legal","finance","corporate"],"description":"Room edition (DRE-3): stored at creation or resolved from the pack; absent on older servers."},"state":{"type":"string","description":"Room state code."},"matterReference":{"type":"string","nullable":true,"description":"Dossier number of the room’s matter, if any."},"clientName":{"type":"string","nullable":true,"description":"Client of the room’s matter, if any."},"documentCount":{"type":"integer","minimum":0,"description":"Live documents in the room (trashed ones excluded)."},"storageBytes":{"type":"integer","minimum":0,"description":"Plaintext bytes of the room’s live originals."},"lastActivityAt":{"type":"string","nullable":true,"format":"date-time","description":"Newest audit event of the room, if visible."},"createdAt":{"type":"string","format":"date-time"},"progress":{"type":"object","properties":{"flows":{"type":"integer","minimum":0,"description":"Requests of the room (every status but draft)."},"items":{"type":"integer","minimum":0,"description":"Items across those requests (the firm total, INT-F18)."},"approved":{"type":"integer","minimum":0,"description":"Items the firm decided (approved or accepted not-applicable)."},"toReview":{"type":"integer","minimum":0,"description":"Submitted items waiting for the firm."}},"required":["flows","items","approved","toReview"],"description":"Request-flow progress of one room; zeros when the caller may not read its requests."}},"required":["id","name","type","state","matterReference","clientName","documentCount","storageBytes","lastActivityAt","createdAt","progress"],"description":"One room the caller may read."},"description":"Readable rooms, most recent activity first."},"reviews":{"type":"array","items":{"type":"object","properties":{"flowId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"title":{"type":"string","description":"Request title."},"toReview":{"type":"integer","minimum":1,"description":"Submitted items waiting for review."},"oldestSubmittedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["flowId","roomId","title","toReview","oldestSubmittedAt"],"description":"A request with submitted items waiting for the firm."},"description":"Requests waiting for review, oldest submission first."},"due":{"type":"array","items":{"type":"object","properties":{"flowId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"title":{"type":"string","description":"Request title."},"dueDate":{"type":"string","format":"date-time","description":"Earliest due date of the request or one of its open items."},"overdue":{"type":"boolean"},"openItems":{"type":"integer","minimum":0,"description":"Required items still to do or rejected."}},"required":["flowId","roomId","title","dueDate","overdue","openItems"],"description":"An open request due within the next days, or overdue."},"description":"Open requests due soon or overdue, earliest first."},"activity":{"type":"object","properties":{"events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event id (the public reference, ADR-0006 D2)."},"seq":{"type":"integer","nullable":true,"description":"Chain sequence number; null while the event awaits sealing (seconds)."},"occurredAt":{"type":"string","format":"date-time","description":"When the event happened (ISO-8601)."},"recordedAt":{"type":"string","format":"date-time","description":"When the database recorded it (ISO-8601)."},"type":{"type":"string","description":"Catalogue event type (e.g. document.downloaded)."},"actorId":{"type":"string","description":"Acting principal id (empty for system and anonymous events)."},"actorKind":{"type":"string","enum":["user","guest","support","service","system","anonymous"],"description":"Kind of actor (ADR-0006 D2)."},"roomId":{"type":"string","nullable":true,"description":"Room id, null outside a room."},"documentId":{"type":"string","nullable":true,"description":"Document/object id, null without one."},"objectType":{"type":"string","nullable":true,"description":"Primary object type code."},"objectId":{"type":"string","nullable":true,"description":"Primary object id."},"details":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"nullable":true},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}]},"description":"Catalogue details: ids, codes and counts only (ADR-0006 D3)."},"ip":{"type":"string","nullable":true,"description":"Client address as seen by the API."},"device":{"type":"string","nullable":true,"description":"Normalised <browser>/<os> label."},"eventDigest":{"type":"string","nullable":true,"description":"SHA-256 event digest (hex), once sealed."},"hash":{"type":"string","nullable":true,"description":"Chain hash after this event (hex), once sealed."}},"required":["seq","occurredAt","type","actorId","roomId","documentId"],"description":"One audit event (ids and codes; names in labels)."},"description":"Newest first; ids and codes only."},"labels":{"type":"object","properties":{"principals":{"type":"object","additionalProperties":{"type":"string"},"description":"Principal id -> display name."},"documents":{"type":"object","additionalProperties":{"type":"string"},"description":"Document id -> title."},"nodes":{"type":"object","additionalProperties":{"type":"string"},"description":"Index node id -> title."},"groups":{"type":"object","additionalProperties":{"type":"string"},"description":"Group id -> name."},"rooms":{"type":"object","additionalProperties":{"type":"string"},"description":"Room id -> name."},"flows":{"type":"object","additionalProperties":{"type":"string"},"description":"Request id -> title."},"items":{"type":"object","additionalProperties":{"type":"string"},"description":"Request item id -> title."}},"required":["principals","documents","nodes","groups","rooms","flows","items"]}},"required":["events","labels"],"description":"Recent activity of the rooms whose audit trail the caller may read."},"storage":{"type":"object","nullable":true,"properties":{"poolBytes":{"type":"integer","minimum":0,"description":"Contractual pool size in plaintext bytes."},"usedBytes":{"type":"integer","minimum":0,"description":"Hot plus archive usage in plaintext bytes."}},"required":["poolBytes","usedBytes"],"description":"Organisation storage pool (ADR-0007 D10); only for firm-wide readers."},"mostViewed":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"title":{"type":"string","nullable":true,"description":"Document title resolved for this reader."},"views":{"type":"integer","minimum":0,"description":"Page and sheet views (audit events) in the period."},"viewers":{"type":"integer","minimum":0,"description":"Distinct people who viewed it."},"lastViewedAt":{"type":"string","format":"date-time"}},"required":["documentId","roomId","title","views","viewers","lastViewedAt"],"description":"One of the most viewed documents."},"description":"Most viewed documents of the last 7 days in the rooms whose audit trail the caller may read (AUD-04)."},"activeNow":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"principalId":{"type":"string","format":"uuid"},"displayName":{"type":"string","nullable":true},"lastSeenAt":{"type":"string","format":"date-time"}},"required":["principalId","displayName","lastSeenAt"]},"description":"Firm users seen in the window, by name."},"guestGroups":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"groupName":{"type":"string","nullable":true},"guests":{"type":"integer","minimum":1}},"required":["groupId","roomId","groupName","guests"]},"description":"Guests seen in the window, as a count per external group of the rooms the caller reads; never names."},"otherGuests":{"type":"integer","minimum":0,"description":"Guests seen whose groups are in rooms the caller does not read."}},"required":["users","guestGroups","otherGuests"],"description":"Sessions seen in the last 15 minutes (AUD-04)."}},"required":["viewer","generatedAt","totals","trends","rooms","reviews","due","activity","storage"],"description":"Firm home dashboard summary for the signed-in firm user."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not a firm user of this tenant (including cross-tenant), or no database.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/permissions/mine":{"get":{"operationId":"getMyNodeAccess","summary":"The caller's own access on one node","description":"ADR-0005 §8 `explain()` for the signed-in principal itself on one node: the read and write levels and the date the granting access ends. Lets the UI offer only what the caller may do (for example Upload for a guest with upload rights on a folder); the server still decides every action itself. Requires `node.read` on the node; every denial except 401 is 404 (PERM-02). Levels and one date only: no group ids, sources or stops. Read-only, not audited (like the index listing's own-view reads).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Node to evaluate; the room id is the room root."},"required":true,"description":"Node to evaluate; the room id is the room root.","name":"nodeId","in":"query"}],"responses":{"200":{"description":"Own access.","content":{"application/json":{"schema":{"type":"object","properties":{"nodeId":{"type":"string","format":"uuid","description":"Evaluated node."},"read":{"type":"string","enum":["none","view","print","download"],"description":"Read axis: none < view < print (watermarked PDF) < download (the original)."},"write":{"type":"string","enum":["none","upload_with_approval","upload","edit","manage"],"description":"Write axis: none < upload_with_approval < upload < edit < manage."},"accessUntil":{"type":"string","nullable":true,"format":"date-time","description":"When the access that grants these levels ends (membership, group or external room end date); null when open-ended or when nothing is granted."},"sourceAccess":{"type":"string","enum":["source","pdf_only"],"description":"`pdf_only`: the caller sees and downloads only the PDF rendition in this room (PERM-12). Absent = `source`."},"viewerProtection":{"type":"object","properties":{"mode":{"type":"string","enum":["off","standard","strict"],"description":"Viewer protection level: `off`, `standard` (default) or `strict` (ADR-0066)."},"reference":{"type":"string","pattern":"^[A-Z2-7]{8}$","description":"Session reference drawn in the moving watermark: base32 of SHA-256 over session id, client IP and day. Never the IP itself."}},"required":["mode","reference"],"description":"Effective screenshot protection in this room and the session reference (ADR-0066). Absent = `off`."}},"required":["nodeId","read","write","accessUntil"],"description":"The caller's own effective levels on one node (ADR-0005 §8 `explain()` for the caller itself). Levels and one date only: no group ids, sources or stops."}}}},"400":{"description":"Invalid query.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out, or stronger authentication is required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/exhibit-register":{"get":{"operationId":"getExhibitRegister","summary":"Read the room exhibit register","description":"The newest active procedure of the room with its parties and every exhibit, numbered per party (ADR-0027). exhibit.read on the room; rows whose source the caller cannot view are redacted to number and status (spec §7). Navigation read: no audit event.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"Register.","content":{"application/json":{"schema":{"type":"object","properties":{"procedure":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid","description":"Procedure id."},"roomId":{"type":"string","format":"uuid","description":"Litigation room the procedure belongs to."},"title":{"type":"string","minLength":1,"maxLength":300,"description":"Case title, e.g. \"Jansen / Pietersen\" (client data)."},"court":{"type":"string","minLength":1,"maxLength":200,"description":"Court name (free text in the MVP)."},"instance":{"type":"string","enum":["first_instance","appeal"],"description":"Instance of the procedure: first instance (rechtbank) or appeal (gerechtshof)."},"caseType":{"type":"string","enum":["summons","application"],"description":"Case type: summons (dagvaarding, incl. kort geding) or application (verzoekschrift)."},"caseNumber":{"type":"string","nullable":true,"maxLength":100,"description":"Zaaknummer / rolnummer; often unknown before filing."},"continuesFromProcedureId":{"type":"string","nullable":true,"format":"uuid","description":"First-instance procedure this appeal continues; title is shown only with current access."},"status":{"type":"string","enum":["active","closed"],"description":"Procedure status; closed is read-only."},"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp (UTC, ISO-8601)."},"closedAt":{"type":"string","nullable":true,"format":"date-time","description":"Close timestamp, or null while active."},"parties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Party id of a procedure."},"procedureId":{"type":"string","format":"uuid","description":"Procedure id."},"role":{"type":"string","enum":["claimant","defendant","applicant","respondent","interested_party","appellant","respondent_on_appeal","intervener","joined_party"],"description":"Role of a party in the procedure."},"displayName":{"type":"string","minLength":1,"maxLength":200,"description":"Full party name as used in the index header (client data)."},"shortName":{"type":"string","minLength":1,"maxLength":40,"description":"Sanitised short name (unique per procedure, case-insensitive)."},"representedByFirm":{"type":"boolean","description":"Default filter in the UI; bundles for other parties are allowed."},"numberingOffset":{"type":"integer","minimum":0,"description":"Appeal continue-numbering offset (0 = start at 1)."},"sortOrder":{"type":"integer","description":"Display order among the procedure parties."},"createdAt":{"type":"string","format":"date-time"}},"required":["id","procedureId","role","displayName","shortName","representedByFirm","numberingOffset","sortOrder","createdAt"],"description":"One party in a procedure."}},"proceduralDocuments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Procedural document id (processtuk)."},"procedureId":{"type":"string","format":"uuid","description":"Procedure id."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"kind":{"type":"string","enum":["summons","statement_of_defence","reply","rejoinder","counterclaim_reply","deed_of_production","deed_of_response","deed_other","hearing_documents","interlocutory_motion","application","statement_of_response","statement_of_appeal","statement_of_response_on_appeal","other"],"description":"Kind of procedural document (processtuk)."},"title":{"type":"string","nullable":true,"maxLength":300,"description":"Custom label; defaults to the NL label of `kind`."},"sequence":{"type":"integer","minimum":0,"description":"Order within the procedure (submitted before drafts)."},"status":{"type":"string","enum":["draft","submitted"],"description":"Procedural document status: only drafts can be reordered or edited."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Optional link to the processtuk in the room index; null after a hard delete of the source and omitted entirely when the caller cannot view it (spec §7)."},"filedOn":{"type":"string","nullable":true,"format":"date","description":"Date the user entered when marking as submitted."},"submittedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","procedureId","partyId","kind","title","sequence","status","filedOn","submittedAt"],"description":"One procedural document (processtuk)."}}},"required":["id","roomId","title","court","instance","caseType","caseNumber","continuesFromProcedureId","status","revision","createdAt","closedAt","parties","proceduralDocuments"],"description":"The newest active procedure of the room, null when none is set up yet."},"exhibits":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"number":{"type":"integer","minimum":1,"maximum":99999},"status":{"type":"string","enum":["active","withdrawn","non_digital"],"description":"Exhibit status; withdrawn keeps its number and slot."},"redacted":{"type":"boolean","enum":[false]},"description":{"type":"string","nullable":true,"maxLength":300,"description":"Default = document title (client data)."},"descriptionIsDefault":{"type":"boolean"},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Shown as \"z.d.\" when empty."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Source document; null after a hard delete."},"documentVersionId":{"type":"string","nullable":true,"format":"uuid","description":"Pinned version (spec §4.7)."},"nodeId":{"type":"string","nullable":true,"format":"uuid","description":"Index node of the source document (links to the viewer)."},"sourceTitle":{"type":"string","nullable":true,"maxLength":500,"description":"Current index title of the source (client data)."},"fileName":{"type":"string","nullable":true,"maxLength":100,"pattern":"^(?<short>[A-Za-z0-9][A-Za-z0-9 ._-]{0,39}) productie (?<n>[1-9][0-9]{0,4})( deel (?<k>[1-9][0-9]?) van (?<m>[1-9][0-9]?))?\\.pdf$","description":"Generated court file name (`{short} productie {n}.pdf`), null when not derivable."},"withdrawnReasonCode":{"type":"string","nullable":true,"enum":["not_relied_on","replaced","filed_in_error","other",null],"description":"Withdrawal reason code."},"newerVersionAvailable":{"type":"boolean","description":"A newer source version with another blob exists."},"sourceInTrash":{"type":"boolean"},"internalSource":{"type":"boolean","description":"The source sits in an internal counsel area (PR-W05)."},"createdAt":{"type":"string","format":"date-time"},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the exhibit set of its party was marked submitted (ADR-0045); the number is then locked."}},"required":["id","partyId","number","status","redacted","description","descriptionIsDefault","documentDate","documentId","documentVersionId","nodeId","sourceTitle","fileName","withdrawnReasonCode","newerVersionAvailable","sourceInTrash","internalSource","createdAt","submittedAt"],"description":"Exhibit of the room register (full row)."},{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"number":{"type":"integer","minimum":1,"maximum":99999},"status":{"type":"string","enum":["active","withdrawn","non_digital"],"description":"Exhibit status; withdrawn keeps its number and slot."},"redacted":{"type":"boolean","enum":[true]},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the exhibit set of its party was marked submitted (ADR-0045); the number is then locked."}},"required":["id","partyId","number","status","redacted","submittedAt"],"additionalProperties":false,"description":"Redacted register row: number and status only."}],"description":"Register row: full for viewable sources, redacted otherwise."},"description":"Exhibits of every party of the procedure, ordered by party then number."},"canManage":{"type":"boolean","description":"The caller may add, withdraw, remove and renumber exhibits."},"canSetUp":{"type":"boolean","description":"The caller may create or edit the procedure and its parties."}},"required":["procedure","exhibits","canManage","canSetUp"],"description":"Room exhibit register (not audited: a navigation read, spec §8)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, or no access (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/exhibit-register/exhibits":{"post":{"operationId":"addRegisterExhibit","summary":"Mark a document as the next exhibit of a party","description":"Pins the current available version of the document and gives it the next free number of the party (max + 1; withdrawn numbers are never reused). exhibit.manage on the room plus view on the source. Writes exhibit.added.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"documentId":{"type":"string","format":"uuid","description":"Source document in this room (404 DOCUMENT_NOT_FOUND)."},"description":{"type":"string","minLength":1,"maxLength":300,"description":"Defaults to the document title."},"documentDate":{"type":"string","format":"date"},"confirmInternalSource":{"type":"boolean","description":"Required for a source in an internal counsel area (422 INTERNAL_SOURCE_NOT_CONFIRMED)."},"expectedRevision":{"type":"integer","minimum":1,"description":"Revision the caller last saw; a mismatch answers 409 REVISION_CONFLICT."}},"required":["partyId","documentId"],"additionalProperties":false,"description":"Mark a document as an exhibit; it gets the next free number of the party."}}}},"responses":{"200":{"description":"Register after the mutation.","content":{"application/json":{"schema":{"type":"object","properties":{"procedure":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid","description":"Procedure id."},"roomId":{"type":"string","format":"uuid","description":"Litigation room the procedure belongs to."},"title":{"type":"string","minLength":1,"maxLength":300,"description":"Case title, e.g. \"Jansen / Pietersen\" (client data)."},"court":{"type":"string","minLength":1,"maxLength":200,"description":"Court name (free text in the MVP)."},"instance":{"type":"string","enum":["first_instance","appeal"],"description":"Instance of the procedure: first instance (rechtbank) or appeal (gerechtshof)."},"caseType":{"type":"string","enum":["summons","application"],"description":"Case type: summons (dagvaarding, incl. kort geding) or application (verzoekschrift)."},"caseNumber":{"type":"string","nullable":true,"maxLength":100,"description":"Zaaknummer / rolnummer; often unknown before filing."},"continuesFromProcedureId":{"type":"string","nullable":true,"format":"uuid","description":"First-instance procedure this appeal continues; title is shown only with current access."},"status":{"type":"string","enum":["active","closed"],"description":"Procedure status; closed is read-only."},"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp (UTC, ISO-8601)."},"closedAt":{"type":"string","nullable":true,"format":"date-time","description":"Close timestamp, or null while active."},"parties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Party id of a procedure."},"procedureId":{"type":"string","format":"uuid","description":"Procedure id."},"role":{"type":"string","enum":["claimant","defendant","applicant","respondent","interested_party","appellant","respondent_on_appeal","intervener","joined_party"],"description":"Role of a party in the procedure."},"displayName":{"type":"string","minLength":1,"maxLength":200,"description":"Full party name as used in the index header (client data)."},"shortName":{"type":"string","minLength":1,"maxLength":40,"description":"Sanitised short name (unique per procedure, case-insensitive)."},"representedByFirm":{"type":"boolean","description":"Default filter in the UI; bundles for other parties are allowed."},"numberingOffset":{"type":"integer","minimum":0,"description":"Appeal continue-numbering offset (0 = start at 1)."},"sortOrder":{"type":"integer","description":"Display order among the procedure parties."},"createdAt":{"type":"string","format":"date-time"}},"required":["id","procedureId","role","displayName","shortName","representedByFirm","numberingOffset","sortOrder","createdAt"],"description":"One party in a procedure."}},"proceduralDocuments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Procedural document id (processtuk)."},"procedureId":{"type":"string","format":"uuid","description":"Procedure id."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"kind":{"type":"string","enum":["summons","statement_of_defence","reply","rejoinder","counterclaim_reply","deed_of_production","deed_of_response","deed_other","hearing_documents","interlocutory_motion","application","statement_of_response","statement_of_appeal","statement_of_response_on_appeal","other"],"description":"Kind of procedural document (processtuk)."},"title":{"type":"string","nullable":true,"maxLength":300,"description":"Custom label; defaults to the NL label of `kind`."},"sequence":{"type":"integer","minimum":0,"description":"Order within the procedure (submitted before drafts)."},"status":{"type":"string","enum":["draft","submitted"],"description":"Procedural document status: only drafts can be reordered or edited."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Optional link to the processtuk in the room index; null after a hard delete of the source and omitted entirely when the caller cannot view it (spec §7)."},"filedOn":{"type":"string","nullable":true,"format":"date","description":"Date the user entered when marking as submitted."},"submittedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","procedureId","partyId","kind","title","sequence","status","filedOn","submittedAt"],"description":"One procedural document (processtuk)."}}},"required":["id","roomId","title","court","instance","caseType","caseNumber","continuesFromProcedureId","status","revision","createdAt","closedAt","parties","proceduralDocuments"],"description":"The newest active procedure of the room, null when none is set up yet."},"exhibits":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"number":{"type":"integer","minimum":1,"maximum":99999},"status":{"type":"string","enum":["active","withdrawn","non_digital"],"description":"Exhibit status; withdrawn keeps its number and slot."},"redacted":{"type":"boolean","enum":[false]},"description":{"type":"string","nullable":true,"maxLength":300,"description":"Default = document title (client data)."},"descriptionIsDefault":{"type":"boolean"},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Shown as \"z.d.\" when empty."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Source document; null after a hard delete."},"documentVersionId":{"type":"string","nullable":true,"format":"uuid","description":"Pinned version (spec §4.7)."},"nodeId":{"type":"string","nullable":true,"format":"uuid","description":"Index node of the source document (links to the viewer)."},"sourceTitle":{"type":"string","nullable":true,"maxLength":500,"description":"Current index title of the source (client data)."},"fileName":{"type":"string","nullable":true,"maxLength":100,"pattern":"^(?<short>[A-Za-z0-9][A-Za-z0-9 ._-]{0,39}) productie (?<n>[1-9][0-9]{0,4})( deel (?<k>[1-9][0-9]?) van (?<m>[1-9][0-9]?))?\\.pdf$","description":"Generated court file name (`{short} productie {n}.pdf`), null when not derivable."},"withdrawnReasonCode":{"type":"string","nullable":true,"enum":["not_relied_on","replaced","filed_in_error","other",null],"description":"Withdrawal reason code."},"newerVersionAvailable":{"type":"boolean","description":"A newer source version with another blob exists."},"sourceInTrash":{"type":"boolean"},"internalSource":{"type":"boolean","description":"The source sits in an internal counsel area (PR-W05)."},"createdAt":{"type":"string","format":"date-time"},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the exhibit set of its party was marked submitted (ADR-0045); the number is then locked."}},"required":["id","partyId","number","status","redacted","description","descriptionIsDefault","documentDate","documentId","documentVersionId","nodeId","sourceTitle","fileName","withdrawnReasonCode","newerVersionAvailable","sourceInTrash","internalSource","createdAt","submittedAt"],"description":"Exhibit of the room register (full row)."},{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"number":{"type":"integer","minimum":1,"maximum":99999},"status":{"type":"string","enum":["active","withdrawn","non_digital"],"description":"Exhibit status; withdrawn keeps its number and slot."},"redacted":{"type":"boolean","enum":[true]},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the exhibit set of its party was marked submitted (ADR-0045); the number is then locked."}},"required":["id","partyId","number","status","redacted","submittedAt"],"additionalProperties":false,"description":"Redacted register row: number and status only."}],"description":"Register row: full for viewable sources, redacted otherwise."},"description":"Exhibits of every party of the procedure, ordered by party then number."},"canManage":{"type":"boolean","description":"The caller may add, withdraw, remove and renumber exhibits."},"canSetUp":{"type":"boolean","description":"The caller may create or edit the procedure and its parties."},"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."}},"required":["procedure","exhibits","canManage","canSetUp","revision"],"description":"Register after the mutation, with the procedure revision it produced."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no exhibit.manage, or no view on the source).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, party, exhibit or document, or no access (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"READ_ONLY, REVISION_CONFLICT, DOCUMENT_NOT_READY or CONFLICT (already an active exhibit).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"422":{"description":"INTERNAL_SOURCE_NOT_CONFIRMED or NUMBER_OUT_OF_RANGE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/exhibit-register/exhibits/{exhibitId}":{"patch":{"operationId":"updateRegisterExhibit","summary":"Edit an exhibit description or date","description":"Changes the description or document date; numbers never change here. exhibit.manage plus view on the source. Writes exhibit.updated with the changed field keys only.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"required":true,"description":"Exhibit id (productie).","name":"exhibitId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","minLength":1,"maxLength":300},"documentDate":{"type":"string","nullable":true,"format":"date"},"expectedRevision":{"type":"integer","minimum":1,"description":"Revision the caller last saw; a mismatch answers 409 REVISION_CONFLICT."}},"additionalProperties":false,"description":"Edit an exhibit description or document date (numbers never change here)."}}}},"responses":{"200":{"description":"Register after the mutation.","content":{"application/json":{"schema":{"type":"object","properties":{"procedure":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid","description":"Procedure id."},"roomId":{"type":"string","format":"uuid","description":"Litigation room the procedure belongs to."},"title":{"type":"string","minLength":1,"maxLength":300,"description":"Case title, e.g. \"Jansen / Pietersen\" (client data)."},"court":{"type":"string","minLength":1,"maxLength":200,"description":"Court name (free text in the MVP)."},"instance":{"type":"string","enum":["first_instance","appeal"],"description":"Instance of the procedure: first instance (rechtbank) or appeal (gerechtshof)."},"caseType":{"type":"string","enum":["summons","application"],"description":"Case type: summons (dagvaarding, incl. kort geding) or application (verzoekschrift)."},"caseNumber":{"type":"string","nullable":true,"maxLength":100,"description":"Zaaknummer / rolnummer; often unknown before filing."},"continuesFromProcedureId":{"type":"string","nullable":true,"format":"uuid","description":"First-instance procedure this appeal continues; title is shown only with current access."},"status":{"type":"string","enum":["active","closed"],"description":"Procedure status; closed is read-only."},"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp (UTC, ISO-8601)."},"closedAt":{"type":"string","nullable":true,"format":"date-time","description":"Close timestamp, or null while active."},"parties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Party id of a procedure."},"procedureId":{"type":"string","format":"uuid","description":"Procedure id."},"role":{"type":"string","enum":["claimant","defendant","applicant","respondent","interested_party","appellant","respondent_on_appeal","intervener","joined_party"],"description":"Role of a party in the procedure."},"displayName":{"type":"string","minLength":1,"maxLength":200,"description":"Full party name as used in the index header (client data)."},"shortName":{"type":"string","minLength":1,"maxLength":40,"description":"Sanitised short name (unique per procedure, case-insensitive)."},"representedByFirm":{"type":"boolean","description":"Default filter in the UI; bundles for other parties are allowed."},"numberingOffset":{"type":"integer","minimum":0,"description":"Appeal continue-numbering offset (0 = start at 1)."},"sortOrder":{"type":"integer","description":"Display order among the procedure parties."},"createdAt":{"type":"string","format":"date-time"}},"required":["id","procedureId","role","displayName","shortName","representedByFirm","numberingOffset","sortOrder","createdAt"],"description":"One party in a procedure."}},"proceduralDocuments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Procedural document id (processtuk)."},"procedureId":{"type":"string","format":"uuid","description":"Procedure id."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"kind":{"type":"string","enum":["summons","statement_of_defence","reply","rejoinder","counterclaim_reply","deed_of_production","deed_of_response","deed_other","hearing_documents","interlocutory_motion","application","statement_of_response","statement_of_appeal","statement_of_response_on_appeal","other"],"description":"Kind of procedural document (processtuk)."},"title":{"type":"string","nullable":true,"maxLength":300,"description":"Custom label; defaults to the NL label of `kind`."},"sequence":{"type":"integer","minimum":0,"description":"Order within the procedure (submitted before drafts)."},"status":{"type":"string","enum":["draft","submitted"],"description":"Procedural document status: only drafts can be reordered or edited."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Optional link to the processtuk in the room index; null after a hard delete of the source and omitted entirely when the caller cannot view it (spec §7)."},"filedOn":{"type":"string","nullable":true,"format":"date","description":"Date the user entered when marking as submitted."},"submittedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","procedureId","partyId","kind","title","sequence","status","filedOn","submittedAt"],"description":"One procedural document (processtuk)."}}},"required":["id","roomId","title","court","instance","caseType","caseNumber","continuesFromProcedureId","status","revision","createdAt","closedAt","parties","proceduralDocuments"],"description":"The newest active procedure of the room, null when none is set up yet."},"exhibits":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"number":{"type":"integer","minimum":1,"maximum":99999},"status":{"type":"string","enum":["active","withdrawn","non_digital"],"description":"Exhibit status; withdrawn keeps its number and slot."},"redacted":{"type":"boolean","enum":[false]},"description":{"type":"string","nullable":true,"maxLength":300,"description":"Default = document title (client data)."},"descriptionIsDefault":{"type":"boolean"},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Shown as \"z.d.\" when empty."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Source document; null after a hard delete."},"documentVersionId":{"type":"string","nullable":true,"format":"uuid","description":"Pinned version (spec §4.7)."},"nodeId":{"type":"string","nullable":true,"format":"uuid","description":"Index node of the source document (links to the viewer)."},"sourceTitle":{"type":"string","nullable":true,"maxLength":500,"description":"Current index title of the source (client data)."},"fileName":{"type":"string","nullable":true,"maxLength":100,"pattern":"^(?<short>[A-Za-z0-9][A-Za-z0-9 ._-]{0,39}) productie (?<n>[1-9][0-9]{0,4})( deel (?<k>[1-9][0-9]?) van (?<m>[1-9][0-9]?))?\\.pdf$","description":"Generated court file name (`{short} productie {n}.pdf`), null when not derivable."},"withdrawnReasonCode":{"type":"string","nullable":true,"enum":["not_relied_on","replaced","filed_in_error","other",null],"description":"Withdrawal reason code."},"newerVersionAvailable":{"type":"boolean","description":"A newer source version with another blob exists."},"sourceInTrash":{"type":"boolean"},"internalSource":{"type":"boolean","description":"The source sits in an internal counsel area (PR-W05)."},"createdAt":{"type":"string","format":"date-time"},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the exhibit set of its party was marked submitted (ADR-0045); the number is then locked."}},"required":["id","partyId","number","status","redacted","description","descriptionIsDefault","documentDate","documentId","documentVersionId","nodeId","sourceTitle","fileName","withdrawnReasonCode","newerVersionAvailable","sourceInTrash","internalSource","createdAt","submittedAt"],"description":"Exhibit of the room register (full row)."},{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"number":{"type":"integer","minimum":1,"maximum":99999},"status":{"type":"string","enum":["active","withdrawn","non_digital"],"description":"Exhibit status; withdrawn keeps its number and slot."},"redacted":{"type":"boolean","enum":[true]},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the exhibit set of its party was marked submitted (ADR-0045); the number is then locked."}},"required":["id","partyId","number","status","redacted","submittedAt"],"additionalProperties":false,"description":"Redacted register row: number and status only."}],"description":"Register row: full for viewable sources, redacted otherwise."},"description":"Exhibits of every party of the procedure, ordered by party then number."},"canManage":{"type":"boolean","description":"The caller may add, withdraw, remove and renumber exhibits."},"canSetUp":{"type":"boolean","description":"The caller may create or edit the procedure and its parties."},"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."}},"required":["procedure","exhibits","canManage","canSetUp","revision"],"description":"Register after the mutation, with the procedure revision it produced."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no exhibit.manage, or no view on the source).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, party, exhibit or document, or no access (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"READ_ONLY or REVISION_CONFLICT.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"delete":{"operationId":"removeRegisterExhibit","summary":"Remove an exhibit designation","description":"Removes an active exhibit; its number stays free until an explicit renumber (numbers are stable). A withdrawn exhibit cannot be removed (409 CONFLICT). exhibit.manage plus view on the source. Writes exhibit.removed.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"required":true,"description":"Exhibit id (productie).","name":"exhibitId","in":"path"}],"responses":{"200":{"description":"Register after the mutation.","content":{"application/json":{"schema":{"type":"object","properties":{"procedure":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid","description":"Procedure id."},"roomId":{"type":"string","format":"uuid","description":"Litigation room the procedure belongs to."},"title":{"type":"string","minLength":1,"maxLength":300,"description":"Case title, e.g. \"Jansen / Pietersen\" (client data)."},"court":{"type":"string","minLength":1,"maxLength":200,"description":"Court name (free text in the MVP)."},"instance":{"type":"string","enum":["first_instance","appeal"],"description":"Instance of the procedure: first instance (rechtbank) or appeal (gerechtshof)."},"caseType":{"type":"string","enum":["summons","application"],"description":"Case type: summons (dagvaarding, incl. kort geding) or application (verzoekschrift)."},"caseNumber":{"type":"string","nullable":true,"maxLength":100,"description":"Zaaknummer / rolnummer; often unknown before filing."},"continuesFromProcedureId":{"type":"string","nullable":true,"format":"uuid","description":"First-instance procedure this appeal continues; title is shown only with current access."},"status":{"type":"string","enum":["active","closed"],"description":"Procedure status; closed is read-only."},"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp (UTC, ISO-8601)."},"closedAt":{"type":"string","nullable":true,"format":"date-time","description":"Close timestamp, or null while active."},"parties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Party id of a procedure."},"procedureId":{"type":"string","format":"uuid","description":"Procedure id."},"role":{"type":"string","enum":["claimant","defendant","applicant","respondent","interested_party","appellant","respondent_on_appeal","intervener","joined_party"],"description":"Role of a party in the procedure."},"displayName":{"type":"string","minLength":1,"maxLength":200,"description":"Full party name as used in the index header (client data)."},"shortName":{"type":"string","minLength":1,"maxLength":40,"description":"Sanitised short name (unique per procedure, case-insensitive)."},"representedByFirm":{"type":"boolean","description":"Default filter in the UI; bundles for other parties are allowed."},"numberingOffset":{"type":"integer","minimum":0,"description":"Appeal continue-numbering offset (0 = start at 1)."},"sortOrder":{"type":"integer","description":"Display order among the procedure parties."},"createdAt":{"type":"string","format":"date-time"}},"required":["id","procedureId","role","displayName","shortName","representedByFirm","numberingOffset","sortOrder","createdAt"],"description":"One party in a procedure."}},"proceduralDocuments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Procedural document id (processtuk)."},"procedureId":{"type":"string","format":"uuid","description":"Procedure id."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"kind":{"type":"string","enum":["summons","statement_of_defence","reply","rejoinder","counterclaim_reply","deed_of_production","deed_of_response","deed_other","hearing_documents","interlocutory_motion","application","statement_of_response","statement_of_appeal","statement_of_response_on_appeal","other"],"description":"Kind of procedural document (processtuk)."},"title":{"type":"string","nullable":true,"maxLength":300,"description":"Custom label; defaults to the NL label of `kind`."},"sequence":{"type":"integer","minimum":0,"description":"Order within the procedure (submitted before drafts)."},"status":{"type":"string","enum":["draft","submitted"],"description":"Procedural document status: only drafts can be reordered or edited."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Optional link to the processtuk in the room index; null after a hard delete of the source and omitted entirely when the caller cannot view it (spec §7)."},"filedOn":{"type":"string","nullable":true,"format":"date","description":"Date the user entered when marking as submitted."},"submittedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","procedureId","partyId","kind","title","sequence","status","filedOn","submittedAt"],"description":"One procedural document (processtuk)."}}},"required":["id","roomId","title","court","instance","caseType","caseNumber","continuesFromProcedureId","status","revision","createdAt","closedAt","parties","proceduralDocuments"],"description":"The newest active procedure of the room, null when none is set up yet."},"exhibits":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"number":{"type":"integer","minimum":1,"maximum":99999},"status":{"type":"string","enum":["active","withdrawn","non_digital"],"description":"Exhibit status; withdrawn keeps its number and slot."},"redacted":{"type":"boolean","enum":[false]},"description":{"type":"string","nullable":true,"maxLength":300,"description":"Default = document title (client data)."},"descriptionIsDefault":{"type":"boolean"},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Shown as \"z.d.\" when empty."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Source document; null after a hard delete."},"documentVersionId":{"type":"string","nullable":true,"format":"uuid","description":"Pinned version (spec §4.7)."},"nodeId":{"type":"string","nullable":true,"format":"uuid","description":"Index node of the source document (links to the viewer)."},"sourceTitle":{"type":"string","nullable":true,"maxLength":500,"description":"Current index title of the source (client data)."},"fileName":{"type":"string","nullable":true,"maxLength":100,"pattern":"^(?<short>[A-Za-z0-9][A-Za-z0-9 ._-]{0,39}) productie (?<n>[1-9][0-9]{0,4})( deel (?<k>[1-9][0-9]?) van (?<m>[1-9][0-9]?))?\\.pdf$","description":"Generated court file name (`{short} productie {n}.pdf`), null when not derivable."},"withdrawnReasonCode":{"type":"string","nullable":true,"enum":["not_relied_on","replaced","filed_in_error","other",null],"description":"Withdrawal reason code."},"newerVersionAvailable":{"type":"boolean","description":"A newer source version with another blob exists."},"sourceInTrash":{"type":"boolean"},"internalSource":{"type":"boolean","description":"The source sits in an internal counsel area (PR-W05)."},"createdAt":{"type":"string","format":"date-time"},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the exhibit set of its party was marked submitted (ADR-0045); the number is then locked."}},"required":["id","partyId","number","status","redacted","description","descriptionIsDefault","documentDate","documentId","documentVersionId","nodeId","sourceTitle","fileName","withdrawnReasonCode","newerVersionAvailable","sourceInTrash","internalSource","createdAt","submittedAt"],"description":"Exhibit of the room register (full row)."},{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"number":{"type":"integer","minimum":1,"maximum":99999},"status":{"type":"string","enum":["active","withdrawn","non_digital"],"description":"Exhibit status; withdrawn keeps its number and slot."},"redacted":{"type":"boolean","enum":[true]},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the exhibit set of its party was marked submitted (ADR-0045); the number is then locked."}},"required":["id","partyId","number","status","redacted","submittedAt"],"additionalProperties":false,"description":"Redacted register row: number and status only."}],"description":"Register row: full for viewable sources, redacted otherwise."},"description":"Exhibits of every party of the procedure, ordered by party then number."},"canManage":{"type":"boolean","description":"The caller may add, withdraw, remove and renumber exhibits."},"canSetUp":{"type":"boolean","description":"The caller may create or edit the procedure and its parties."},"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."}},"required":["procedure","exhibits","canManage","canSetUp","revision"],"description":"Register after the mutation, with the procedure revision it produced."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no exhibit.manage, or no view on the source).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, party, exhibit or document, or no access (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"READ_ONLY, CONFLICT (withdrawn exhibits stay listed) or EXHIBIT_SUBMITTED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/exhibit-register/exhibits/{exhibitId}/withdraw":{"post":{"operationId":"withdrawRegisterExhibit","summary":"Withdraw an exhibit (keeps its number)","description":"Marks the exhibit withdrawn (ingetrokken) with a reason code; the number is kept and never reused, and the index lists it. exhibit.manage plus view on the source. Writes exhibit.withdrawn.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"required":true,"description":"Exhibit id (productie).","name":"exhibitId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["not_relied_on","replaced","filed_in_error","other"],"description":"Withdrawal reason code."},"expectedRevision":{"type":"integer","minimum":1,"description":"Revision the caller last saw; a mismatch answers 409 REVISION_CONFLICT."}},"required":["reasonCode"],"additionalProperties":false,"description":"Withdraw an exhibit: it keeps its number (ingetrokken), which is never reused."}}}},"responses":{"200":{"description":"Register after the mutation.","content":{"application/json":{"schema":{"type":"object","properties":{"procedure":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid","description":"Procedure id."},"roomId":{"type":"string","format":"uuid","description":"Litigation room the procedure belongs to."},"title":{"type":"string","minLength":1,"maxLength":300,"description":"Case title, e.g. \"Jansen / Pietersen\" (client data)."},"court":{"type":"string","minLength":1,"maxLength":200,"description":"Court name (free text in the MVP)."},"instance":{"type":"string","enum":["first_instance","appeal"],"description":"Instance of the procedure: first instance (rechtbank) or appeal (gerechtshof)."},"caseType":{"type":"string","enum":["summons","application"],"description":"Case type: summons (dagvaarding, incl. kort geding) or application (verzoekschrift)."},"caseNumber":{"type":"string","nullable":true,"maxLength":100,"description":"Zaaknummer / rolnummer; often unknown before filing."},"continuesFromProcedureId":{"type":"string","nullable":true,"format":"uuid","description":"First-instance procedure this appeal continues; title is shown only with current access."},"status":{"type":"string","enum":["active","closed"],"description":"Procedure status; closed is read-only."},"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp (UTC, ISO-8601)."},"closedAt":{"type":"string","nullable":true,"format":"date-time","description":"Close timestamp, or null while active."},"parties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Party id of a procedure."},"procedureId":{"type":"string","format":"uuid","description":"Procedure id."},"role":{"type":"string","enum":["claimant","defendant","applicant","respondent","interested_party","appellant","respondent_on_appeal","intervener","joined_party"],"description":"Role of a party in the procedure."},"displayName":{"type":"string","minLength":1,"maxLength":200,"description":"Full party name as used in the index header (client data)."},"shortName":{"type":"string","minLength":1,"maxLength":40,"description":"Sanitised short name (unique per procedure, case-insensitive)."},"representedByFirm":{"type":"boolean","description":"Default filter in the UI; bundles for other parties are allowed."},"numberingOffset":{"type":"integer","minimum":0,"description":"Appeal continue-numbering offset (0 = start at 1)."},"sortOrder":{"type":"integer","description":"Display order among the procedure parties."},"createdAt":{"type":"string","format":"date-time"}},"required":["id","procedureId","role","displayName","shortName","representedByFirm","numberingOffset","sortOrder","createdAt"],"description":"One party in a procedure."}},"proceduralDocuments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Procedural document id (processtuk)."},"procedureId":{"type":"string","format":"uuid","description":"Procedure id."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"kind":{"type":"string","enum":["summons","statement_of_defence","reply","rejoinder","counterclaim_reply","deed_of_production","deed_of_response","deed_other","hearing_documents","interlocutory_motion","application","statement_of_response","statement_of_appeal","statement_of_response_on_appeal","other"],"description":"Kind of procedural document (processtuk)."},"title":{"type":"string","nullable":true,"maxLength":300,"description":"Custom label; defaults to the NL label of `kind`."},"sequence":{"type":"integer","minimum":0,"description":"Order within the procedure (submitted before drafts)."},"status":{"type":"string","enum":["draft","submitted"],"description":"Procedural document status: only drafts can be reordered or edited."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Optional link to the processtuk in the room index; null after a hard delete of the source and omitted entirely when the caller cannot view it (spec §7)."},"filedOn":{"type":"string","nullable":true,"format":"date","description":"Date the user entered when marking as submitted."},"submittedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","procedureId","partyId","kind","title","sequence","status","filedOn","submittedAt"],"description":"One procedural document (processtuk)."}}},"required":["id","roomId","title","court","instance","caseType","caseNumber","continuesFromProcedureId","status","revision","createdAt","closedAt","parties","proceduralDocuments"],"description":"The newest active procedure of the room, null when none is set up yet."},"exhibits":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"number":{"type":"integer","minimum":1,"maximum":99999},"status":{"type":"string","enum":["active","withdrawn","non_digital"],"description":"Exhibit status; withdrawn keeps its number and slot."},"redacted":{"type":"boolean","enum":[false]},"description":{"type":"string","nullable":true,"maxLength":300,"description":"Default = document title (client data)."},"descriptionIsDefault":{"type":"boolean"},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Shown as \"z.d.\" when empty."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Source document; null after a hard delete."},"documentVersionId":{"type":"string","nullable":true,"format":"uuid","description":"Pinned version (spec §4.7)."},"nodeId":{"type":"string","nullable":true,"format":"uuid","description":"Index node of the source document (links to the viewer)."},"sourceTitle":{"type":"string","nullable":true,"maxLength":500,"description":"Current index title of the source (client data)."},"fileName":{"type":"string","nullable":true,"maxLength":100,"pattern":"^(?<short>[A-Za-z0-9][A-Za-z0-9 ._-]{0,39}) productie (?<n>[1-9][0-9]{0,4})( deel (?<k>[1-9][0-9]?) van (?<m>[1-9][0-9]?))?\\.pdf$","description":"Generated court file name (`{short} productie {n}.pdf`), null when not derivable."},"withdrawnReasonCode":{"type":"string","nullable":true,"enum":["not_relied_on","replaced","filed_in_error","other",null],"description":"Withdrawal reason code."},"newerVersionAvailable":{"type":"boolean","description":"A newer source version with another blob exists."},"sourceInTrash":{"type":"boolean"},"internalSource":{"type":"boolean","description":"The source sits in an internal counsel area (PR-W05)."},"createdAt":{"type":"string","format":"date-time"},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the exhibit set of its party was marked submitted (ADR-0045); the number is then locked."}},"required":["id","partyId","number","status","redacted","description","descriptionIsDefault","documentDate","documentId","documentVersionId","nodeId","sourceTitle","fileName","withdrawnReasonCode","newerVersionAvailable","sourceInTrash","internalSource","createdAt","submittedAt"],"description":"Exhibit of the room register (full row)."},{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"number":{"type":"integer","minimum":1,"maximum":99999},"status":{"type":"string","enum":["active","withdrawn","non_digital"],"description":"Exhibit status; withdrawn keeps its number and slot."},"redacted":{"type":"boolean","enum":[true]},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the exhibit set of its party was marked submitted (ADR-0045); the number is then locked."}},"required":["id","partyId","number","status","redacted","submittedAt"],"additionalProperties":false,"description":"Redacted register row: number and status only."}],"description":"Register row: full for viewable sources, redacted otherwise."},"description":"Exhibits of every party of the procedure, ordered by party then number."},"canManage":{"type":"boolean","description":"The caller may add, withdraw, remove and renumber exhibits."},"canSetUp":{"type":"boolean","description":"The caller may create or edit the procedure and its parties."},"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."}},"required":["procedure","exhibits","canManage","canSetUp","revision"],"description":"Register after the mutation, with the procedure revision it produced."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no exhibit.manage, or no view on the source).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, party, exhibit or document, or no access (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"READ_ONLY, REVISION_CONFLICT, CONFLICT (already withdrawn) or EXHIBIT_SUBMITTED (ADR-0045).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/exhibit-register/order":{"put":{"operationId":"renumberRegisterExhibits","summary":"Explicitly renumber the exhibits of a party","description":"The body lists every exhibit of the party (withdrawn ones included) in the new order; numbers become offset+1..offset+n. Order-only: exhibit.manage on the room, no per-source check. expectedRevision is required. Writes exhibit.renumbered with the number of changed exhibits.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"exhibitIds":{"type":"array","items":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"minItems":1,"maxItems":1000,"description":"Every exhibit of the party in the new order (422 ORDER_NOT_PERMUTATION otherwise)."},"expectedRevision":{"type":"integer","minimum":1,"description":"Required: renumbering changes filed numbers."}},"required":["partyId","exhibitIds","expectedRevision"],"additionalProperties":false,"description":"Renumber a party: numbers become offset+1..offset+n in the given order (audited)."}}}},"responses":{"200":{"description":"Register after the mutation.","content":{"application/json":{"schema":{"type":"object","properties":{"procedure":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid","description":"Procedure id."},"roomId":{"type":"string","format":"uuid","description":"Litigation room the procedure belongs to."},"title":{"type":"string","minLength":1,"maxLength":300,"description":"Case title, e.g. \"Jansen / Pietersen\" (client data)."},"court":{"type":"string","minLength":1,"maxLength":200,"description":"Court name (free text in the MVP)."},"instance":{"type":"string","enum":["first_instance","appeal"],"description":"Instance of the procedure: first instance (rechtbank) or appeal (gerechtshof)."},"caseType":{"type":"string","enum":["summons","application"],"description":"Case type: summons (dagvaarding, incl. kort geding) or application (verzoekschrift)."},"caseNumber":{"type":"string","nullable":true,"maxLength":100,"description":"Zaaknummer / rolnummer; often unknown before filing."},"continuesFromProcedureId":{"type":"string","nullable":true,"format":"uuid","description":"First-instance procedure this appeal continues; title is shown only with current access."},"status":{"type":"string","enum":["active","closed"],"description":"Procedure status; closed is read-only."},"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp (UTC, ISO-8601)."},"closedAt":{"type":"string","nullable":true,"format":"date-time","description":"Close timestamp, or null while active."},"parties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Party id of a procedure."},"procedureId":{"type":"string","format":"uuid","description":"Procedure id."},"role":{"type":"string","enum":["claimant","defendant","applicant","respondent","interested_party","appellant","respondent_on_appeal","intervener","joined_party"],"description":"Role of a party in the procedure."},"displayName":{"type":"string","minLength":1,"maxLength":200,"description":"Full party name as used in the index header (client data)."},"shortName":{"type":"string","minLength":1,"maxLength":40,"description":"Sanitised short name (unique per procedure, case-insensitive)."},"representedByFirm":{"type":"boolean","description":"Default filter in the UI; bundles for other parties are allowed."},"numberingOffset":{"type":"integer","minimum":0,"description":"Appeal continue-numbering offset (0 = start at 1)."},"sortOrder":{"type":"integer","description":"Display order among the procedure parties."},"createdAt":{"type":"string","format":"date-time"}},"required":["id","procedureId","role","displayName","shortName","representedByFirm","numberingOffset","sortOrder","createdAt"],"description":"One party in a procedure."}},"proceduralDocuments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Procedural document id (processtuk)."},"procedureId":{"type":"string","format":"uuid","description":"Procedure id."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"kind":{"type":"string","enum":["summons","statement_of_defence","reply","rejoinder","counterclaim_reply","deed_of_production","deed_of_response","deed_other","hearing_documents","interlocutory_motion","application","statement_of_response","statement_of_appeal","statement_of_response_on_appeal","other"],"description":"Kind of procedural document (processtuk)."},"title":{"type":"string","nullable":true,"maxLength":300,"description":"Custom label; defaults to the NL label of `kind`."},"sequence":{"type":"integer","minimum":0,"description":"Order within the procedure (submitted before drafts)."},"status":{"type":"string","enum":["draft","submitted"],"description":"Procedural document status: only drafts can be reordered or edited."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Optional link to the processtuk in the room index; null after a hard delete of the source and omitted entirely when the caller cannot view it (spec §7)."},"filedOn":{"type":"string","nullable":true,"format":"date","description":"Date the user entered when marking as submitted."},"submittedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","procedureId","partyId","kind","title","sequence","status","filedOn","submittedAt"],"description":"One procedural document (processtuk)."}}},"required":["id","roomId","title","court","instance","caseType","caseNumber","continuesFromProcedureId","status","revision","createdAt","closedAt","parties","proceduralDocuments"],"description":"The newest active procedure of the room, null when none is set up yet."},"exhibits":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"number":{"type":"integer","minimum":1,"maximum":99999},"status":{"type":"string","enum":["active","withdrawn","non_digital"],"description":"Exhibit status; withdrawn keeps its number and slot."},"redacted":{"type":"boolean","enum":[false]},"description":{"type":"string","nullable":true,"maxLength":300,"description":"Default = document title (client data)."},"descriptionIsDefault":{"type":"boolean"},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Shown as \"z.d.\" when empty."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Source document; null after a hard delete."},"documentVersionId":{"type":"string","nullable":true,"format":"uuid","description":"Pinned version (spec §4.7)."},"nodeId":{"type":"string","nullable":true,"format":"uuid","description":"Index node of the source document (links to the viewer)."},"sourceTitle":{"type":"string","nullable":true,"maxLength":500,"description":"Current index title of the source (client data)."},"fileName":{"type":"string","nullable":true,"maxLength":100,"pattern":"^(?<short>[A-Za-z0-9][A-Za-z0-9 ._-]{0,39}) productie (?<n>[1-9][0-9]{0,4})( deel (?<k>[1-9][0-9]?) van (?<m>[1-9][0-9]?))?\\.pdf$","description":"Generated court file name (`{short} productie {n}.pdf`), null when not derivable."},"withdrawnReasonCode":{"type":"string","nullable":true,"enum":["not_relied_on","replaced","filed_in_error","other",null],"description":"Withdrawal reason code."},"newerVersionAvailable":{"type":"boolean","description":"A newer source version with another blob exists."},"sourceInTrash":{"type":"boolean"},"internalSource":{"type":"boolean","description":"The source sits in an internal counsel area (PR-W05)."},"createdAt":{"type":"string","format":"date-time"},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the exhibit set of its party was marked submitted (ADR-0045); the number is then locked."}},"required":["id","partyId","number","status","redacted","description","descriptionIsDefault","documentDate","documentId","documentVersionId","nodeId","sourceTitle","fileName","withdrawnReasonCode","newerVersionAvailable","sourceInTrash","internalSource","createdAt","submittedAt"],"description":"Exhibit of the room register (full row)."},{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"number":{"type":"integer","minimum":1,"maximum":99999},"status":{"type":"string","enum":["active","withdrawn","non_digital"],"description":"Exhibit status; withdrawn keeps its number and slot."},"redacted":{"type":"boolean","enum":[true]},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the exhibit set of its party was marked submitted (ADR-0045); the number is then locked."}},"required":["id","partyId","number","status","redacted","submittedAt"],"additionalProperties":false,"description":"Redacted register row: number and status only."}],"description":"Register row: full for viewable sources, redacted otherwise."},"description":"Exhibits of every party of the procedure, ordered by party then number."},"canManage":{"type":"boolean","description":"The caller may add, withdraw, remove and renumber exhibits."},"canSetUp":{"type":"boolean","description":"The caller may create or edit the procedure and its parties."},"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."}},"required":["procedure","exhibits","canManage","canSetUp","revision"],"description":"Register after the mutation, with the procedure revision it produced."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no exhibit.manage, or no view on the source).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, party, exhibit or document, or no access (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"READ_ONLY, REVISION_CONFLICT or EXHIBIT_SUBMITTED (a submitted number would change).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"422":{"description":"ORDER_NOT_PERMUTATION.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/mortgage/files":{"get":{"operationId":"listMortgageFiles","summary":"List the mortgage files the caller may read","description":"Every room with a mortgage file record in which the caller has flow.read (members and compliance), with checklist counts, the three deadlines and their risk, sorted by risk. Navigation read (flow.read is audit never): no audit event.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"Files.","content":{"application/json":{"schema":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid"},"roomName":{"type":"string","nullable":true,"description":"Room name (client data)."},"file":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"reference":{"type":"string","nullable":true,"maxLength":40,"description":"Office reference (client data)."},"applicantNames":{"type":"array","items":{"type":"string","minLength":1,"maxLength":120},"maxItems":2,"description":"One or two applicants (client data)."},"purpose":{"type":"string","enum":["purchase","refinance","move","divorce","construction"],"description":"Purpose of the mortgage: purchase, refinance, move, divorce or construction."},"loanAmountCents":{"type":"integer","nullable":true,"minimum":0,"description":"Loan amount in euro cents."},"stage":{"type":"string","enum":["orientation","fact_finding","advice","application","offer","notary","aftercare"],"description":"Stage of the mortgage file."},"financingConditionDate":{"type":"string","nullable":true,"format":"date"},"bindingOfferDate":{"type":"string","nullable":true,"format":"date","description":"Binding offer valid until."},"notaryDate":{"type":"string","nullable":true,"format":"date"},"revision":{"type":"integer","minimum":1},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","reference","applicantNames","purpose","loanAmountCents","stage","financingConditionDate","bindingOfferDate","notaryDate","revision","updatedAt"],"description":"Mortgage file record of one room."},"checklist":{"type":"object","properties":{"total":{"type":"integer","minimum":0},"done":{"type":"integer","minimum":0,"description":"Approved or not applicable."},"toReview":{"type":"integer","minimum":0,"description":"Submitted, waiting for the adviser."},"missing":{"type":"integer","minimum":0,"description":"To do or rejected in a sent request."}},"required":["total","done","toReview","missing"],"description":"Required-item counts of the file checklist."},"deadlines":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["financing_condition","binding_offer","notary"],"description":"Financing condition, binding offer (valid until) or notary date."},"date":{"type":"string","nullable":true,"format":"date","description":"Agreed date, or null when not recorded yet."},"daysLeft":{"type":"integer","nullable":true,"description":"Days from today (negative when passed)."},"risk":{"type":"string","enum":["met","overdue","at_risk","on_track","no_date"],"description":"Deadline risk."}},"required":["kind","date","daysLeft","risk"],"description":"One deadline of a mortgage file with its computed risk."}},"nextDeadline":{"type":"object","nullable":true,"properties":{"kind":{"type":"string","enum":["financing_condition","binding_offer","notary"],"description":"Financing condition, binding offer (valid until) or notary date."},"date":{"type":"string","nullable":true,"format":"date","description":"Agreed date, or null when not recorded yet."},"daysLeft":{"type":"integer","nullable":true,"description":"Days from today (negative when passed)."},"risk":{"type":"string","enum":["met","overdue","at_risk","on_track","no_date"],"description":"Deadline risk."}},"required":["kind","date","daysLeft","risk"],"description":"The first open deadline with a date."},"bsnFlagCount":{"type":"integer","minimum":0,"description":"Documents in the room flagged by the BSN guardrail."},"expiredCount":{"type":"integer","minimum":0,"description":"Checklist items whose validity has ended."}},"required":["roomId","roomName","file","checklist","deadlines","nextDeadline","bsnFlagCount","expiredCount"],"description":"One mortgage file in the overview."}}},"required":["files"],"description":"The mortgage files the caller may read, deadline risk first."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, no access, or not a firm user (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/mortgage-file":{"get":{"operationId":"getMortgageFile","summary":"Read the mortgage file of a room","description":"File record (null while none exists), checklist counts, deadlines with risk and the validity of every checklist item with a validity rule. flow.read on the room.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"File view.","content":{"application/json":{"schema":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid"},"roomName":{"type":"string","nullable":true},"file":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"reference":{"type":"string","nullable":true,"maxLength":40,"description":"Office reference (client data)."},"applicantNames":{"type":"array","items":{"type":"string","minLength":1,"maxLength":120},"maxItems":2,"description":"One or two applicants (client data)."},"purpose":{"type":"string","enum":["purchase","refinance","move","divorce","construction"],"description":"Purpose of the mortgage: purchase, refinance, move, divorce or construction."},"loanAmountCents":{"type":"integer","nullable":true,"minimum":0,"description":"Loan amount in euro cents."},"stage":{"type":"string","enum":["orientation","fact_finding","advice","application","offer","notary","aftercare"],"description":"Stage of the mortgage file."},"financingConditionDate":{"type":"string","nullable":true,"format":"date"},"bindingOfferDate":{"type":"string","nullable":true,"format":"date","description":"Binding offer valid until."},"notaryDate":{"type":"string","nullable":true,"format":"date"},"revision":{"type":"integer","minimum":1},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","reference","applicantNames","purpose","loanAmountCents","stage","financingConditionDate","bindingOfferDate","notaryDate","revision","updatedAt"],"description":"Null while the room has no file record yet."},"checklist":{"type":"object","properties":{"total":{"type":"integer","minimum":0},"done":{"type":"integer","minimum":0,"description":"Approved or not applicable."},"toReview":{"type":"integer","minimum":0,"description":"Submitted, waiting for the adviser."},"missing":{"type":"integer","minimum":0,"description":"To do or rejected in a sent request."}},"required":["total","done","toReview","missing"],"description":"Required-item counts of the file checklist."},"deadlines":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["financing_condition","binding_offer","notary"],"description":"Financing condition, binding offer (valid until) or notary date."},"date":{"type":"string","nullable":true,"format":"date","description":"Agreed date, or null when not recorded yet."},"daysLeft":{"type":"integer","nullable":true,"description":"Days from today (negative when passed)."},"risk":{"type":"string","enum":["met","overdue","at_risk","on_track","no_date"],"description":"Deadline risk."}},"required":["kind","date","daysLeft","risk"],"description":"One deadline of a mortgage file with its computed risk."}},"validity":{"type":"array","items":{"type":"object","properties":{"flowId":{"type":"string","format":"uuid"},"itemId":{"type":"string","format":"uuid"},"title":{"type":"string","nullable":true,"description":"Item title (client data)."},"itemStatus":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"]},"rule":{"type":"string","enum":["max_age","not_expired"],"description":"Validity rule."},"maxAgeMonths":{"type":"integer","nullable":true,"minimum":1,"maximum":120},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Document date (max_age) or expiry date (not_expired) the adviser entered."},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"],"description":"`unknown` until the adviser enters the document date."},"ruleSource":{"type":"string","enum":["set","template"],"description":"Stored by the adviser, or suggested from E20."}},"required":["flowId","itemId","title","itemStatus","rule","maxAgeMonths","documentDate","validUntil","daysLeft","status","ruleSource"],"description":"Validity of one checklist item."}},"bsnFlagCount":{"type":"integer","minimum":0},"today":{"type":"string","format":"date","description":"Server date the day counts refer to (Europe/Amsterdam)."}},"required":["roomId","roomName","file","checklist","deadlines","validity","bsnFlagCount","today"],"description":"Mortgage file view of one room."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, no access, or not a firm user (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"put":{"operationId":"upsertMortgageFile","summary":"Create or replace the mortgage file of a room","description":"flow.create on the room (manage, users only, not in a frozen/closed/archived room). Audited as mortgage_file.updated with field codes only.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reference":{"type":"string","nullable":true,"minLength":1,"maxLength":40},"applicantNames":{"type":"array","items":{"type":"string","minLength":1,"maxLength":120},"minItems":1,"maxItems":2},"purpose":{"type":"string","enum":["purchase","refinance","move","divorce","construction"],"description":"Purpose of the mortgage: purchase, refinance, move, divorce or construction."},"loanAmountCents":{"type":"integer","nullable":true,"minimum":0,"maximum":1000000000000},"stage":{"type":"string","enum":["orientation","fact_finding","advice","application","offer","notary","aftercare"],"description":"Stage of the mortgage file."},"financingConditionDate":{"type":"string","nullable":true,"format":"date"},"bindingOfferDate":{"type":"string","nullable":true,"format":"date"},"notaryDate":{"type":"string","nullable":true,"format":"date"},"expectedRevision":{"type":"integer","minimum":1,"description":"Optimistic concurrency: the revision the caller read (409 on mismatch)."}},"required":["reference","applicantNames","purpose","loanAmountCents","stage","financingConditionDate","bindingOfferDate","notaryDate"],"additionalProperties":false,"description":"Create or replace the mortgage file of a room."}}}},"responses":{"200":{"description":"File view.","content":{"application/json":{"schema":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid"},"roomName":{"type":"string","nullable":true},"file":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"reference":{"type":"string","nullable":true,"maxLength":40,"description":"Office reference (client data)."},"applicantNames":{"type":"array","items":{"type":"string","minLength":1,"maxLength":120},"maxItems":2,"description":"One or two applicants (client data)."},"purpose":{"type":"string","enum":["purchase","refinance","move","divorce","construction"],"description":"Purpose of the mortgage: purchase, refinance, move, divorce or construction."},"loanAmountCents":{"type":"integer","nullable":true,"minimum":0,"description":"Loan amount in euro cents."},"stage":{"type":"string","enum":["orientation","fact_finding","advice","application","offer","notary","aftercare"],"description":"Stage of the mortgage file."},"financingConditionDate":{"type":"string","nullable":true,"format":"date"},"bindingOfferDate":{"type":"string","nullable":true,"format":"date","description":"Binding offer valid until."},"notaryDate":{"type":"string","nullable":true,"format":"date"},"revision":{"type":"integer","minimum":1},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","reference","applicantNames","purpose","loanAmountCents","stage","financingConditionDate","bindingOfferDate","notaryDate","revision","updatedAt"],"description":"Null while the room has no file record yet."},"checklist":{"type":"object","properties":{"total":{"type":"integer","minimum":0},"done":{"type":"integer","minimum":0,"description":"Approved or not applicable."},"toReview":{"type":"integer","minimum":0,"description":"Submitted, waiting for the adviser."},"missing":{"type":"integer","minimum":0,"description":"To do or rejected in a sent request."}},"required":["total","done","toReview","missing"],"description":"Required-item counts of the file checklist."},"deadlines":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["financing_condition","binding_offer","notary"],"description":"Financing condition, binding offer (valid until) or notary date."},"date":{"type":"string","nullable":true,"format":"date","description":"Agreed date, or null when not recorded yet."},"daysLeft":{"type":"integer","nullable":true,"description":"Days from today (negative when passed)."},"risk":{"type":"string","enum":["met","overdue","at_risk","on_track","no_date"],"description":"Deadline risk."}},"required":["kind","date","daysLeft","risk"],"description":"One deadline of a mortgage file with its computed risk."}},"validity":{"type":"array","items":{"type":"object","properties":{"flowId":{"type":"string","format":"uuid"},"itemId":{"type":"string","format":"uuid"},"title":{"type":"string","nullable":true,"description":"Item title (client data)."},"itemStatus":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"]},"rule":{"type":"string","enum":["max_age","not_expired"],"description":"Validity rule."},"maxAgeMonths":{"type":"integer","nullable":true,"minimum":1,"maximum":120},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Document date (max_age) or expiry date (not_expired) the adviser entered."},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"],"description":"`unknown` until the adviser enters the document date."},"ruleSource":{"type":"string","enum":["set","template"],"description":"Stored by the adviser, or suggested from E20."}},"required":["flowId","itemId","title","itemStatus","rule","maxAgeMonths","documentDate","validUntil","daysLeft","status","ruleSource"],"description":"Validity of one checklist item."}},"bsnFlagCount":{"type":"integer","minimum":0},"today":{"type":"string","format":"date","description":"Server date the day counts refer to (Europe/Amsterdam)."}},"required":["roomId","roomName","file","checklist","deadlines","validity","bsnFlagCount","today"],"description":"Mortgage file view of one room."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no manage on the room, or room not active). A read-only compliance caller that tries to write gets 403 READ_ONLY.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, no access, or not a firm user (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"REVISION_CONFLICT: the file changed since it was read. INVALID_STAGE_TRANSITION: the stage move is not allowed (a skipped stage, a two-step jump back, or a move out of aftercare; staying put, one step forward and one step back are allowed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/flows/{flowId}/items/{itemId}/validity":{"put":{"operationId":"setFlowItemValidity","summary":"Enter the document date of a checklist item","description":"flow_item.review on the item node (manage, users only). The server derives valid-until (max_age: date + months; not_expired: the entered expiry date). Audited as flow_item.validity_set with ids and the rule code only.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"rule":{"type":"string","enum":["max_age","not_expired"],"description":"Validity rule."},"maxAgeMonths":{"type":"integer","nullable":true,"minimum":1,"maximum":120},"documentDate":{"type":"string","format":"date"}},"required":["rule","maxAgeMonths","documentDate"],"additionalProperties":false,"description":"Enter the document date (max_age) or the expiry date (not_expired) of one item."}}}},"responses":{"200":{"description":"Validity.","content":{"application/json":{"schema":{"type":"object","properties":{"flowId":{"type":"string","format":"uuid"},"itemId":{"type":"string","format":"uuid"},"title":{"type":"string","nullable":true,"description":"Item title (client data)."},"itemStatus":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"]},"rule":{"type":"string","enum":["max_age","not_expired"],"description":"Validity rule."},"maxAgeMonths":{"type":"integer","nullable":true,"minimum":1,"maximum":120},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Document date (max_age) or expiry date (not_expired) the adviser entered."},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"],"description":"`unknown` until the adviser enters the document date."},"ruleSource":{"type":"string","enum":["set","template"],"description":"Stored by the adviser, or suggested from E20."}},"required":["flowId","itemId","title","itemStatus","rule","maxAgeMonths","documentDate","validUntil","daysLeft","status","ruleSource"],"description":"Validity of one checklist item."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no manage on the item).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, no access, or not a firm user (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/guardrail-flags":{"get":{"operationId":"listGuardrailFlags","summary":"List the BSN guardrail flags of a room","description":"Current versions of live documents whose text contains a number passing the BSN eleven-test, with page numbers only (never the number). flow.read on the room.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"Flags.","content":{"application/json":{"schema":{"type":"object","properties":{"flags":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid"},"versionId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":1},"kind":{"type":"string","enum":["bsn_detected"]},"pageNos":{"type":"array","items":{"type":"integer","minimum":1},"minItems":1},"detectedAt":{"type":"string","format":"date-time"},"title":{"type":"string","nullable":true,"description":"Document title (client data)."}},"required":["documentId","versionId","versionNo","kind","pageNos","detectedAt","title"],"description":"A document version whose text contains a number passing the BSN eleven-test."}}},"required":["flags"],"description":"BSN guardrail flags of the room (current versions of live documents)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, no access, or not a firm user (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/audit-reports/kifid":{"post":{"operationId":"generateKifidPack","summary":"Generate the Kifid pack CSV of a mortgage file","description":"audit.read_room (firm_admin/compliance with manage). The room audit report extended with the file, its deadlines and every request item with its status, decision and validity; SHA-256 over the exact CSV bytes. Download through downloadAuditReport (audit.export.download, step-up). Emits audit.report_generated.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"201":{"description":"Generated.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Stored report id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"roomId":{"type":"string","format":"uuid","description":"Reported room."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."},"expiresAt":{"type":"string","format":"date-time","description":"Download expiry (+7 days)."},"sha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"SHA-256 hex of the exact CSV bytes."},"rowCount":{"type":"integer","description":"Rows in the stored CSV."},"verification":{"type":"object","properties":{"status":{"type":"string","enum":["verified","failed"],"description":"Chain verification outcome."},"checkedAt":{"type":"string","format":"date-time","description":"When the check ran (ISO-8601)."},"eventCount":{"type":"integer","description":"Events covered by the check."},"firstSeq":{"type":"integer","nullable":true,"description":"First sequence covered, null when empty."},"lastSeq":{"type":"integer","nullable":true,"description":"Last sequence covered, null when empty."},"headSeq":{"type":"integer","nullable":true,"description":"Verified chain head sequence."},"headHash":{"type":"string","nullable":true,"description":"Verified chain head hash (hex)."},"failureCode":{"type":"string","nullable":true,"description":"ADR-0006 D8 failure code when failed."},"failedSeq":{"type":"integer","nullable":true,"description":"First failing sequence when failed."}},"required":["status","checkedAt","eventCount","firstSeq","lastSeq"],"description":"Verification summary attached to every report."},"sections":{"type":"array","items":{"type":"string","enum":["file","deadlines","checklist","audit_trail"]},"description":"Sections in the CSV."}},"required":["id","tenantId","roomId","createdAt","expiresAt","sha256","rowCount","verification","sections"],"description":"Generated Kifid pack metadata; the CSV downloads through downloadAuditReport."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, no access, or not a firm user (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"AUDIT_UNAVAILABLE: the audit event could not be written; nothing was served (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/qa":{"get":{"operationId":"getRoomQa","summary":"Q&A overview of a room for the caller","description":"qa.read on the room. Whether Q&A is enabled, the caller role, status counts, the bidder quota (bidders) and the settings, bidder groups and experts (coordinators). A room without Q&A answers 404 except to a coordinator (enabled false).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"Overview.","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"role":{"type":"string","enum":["coordinator","expert","observer","bidder"],"description":"coordinator = qa.manage, expert = qa.answer, observer = internal read only, bidder = guest of an external group."},"counts":{"type":"object","properties":{"open":{"type":"integer","minimum":0},"in_progress":{"type":"integer","minimum":0},"answered":{"type":"integer","minimum":0},"published":{"type":"integer","minimum":0},"rejected":{"type":"integer","minimum":0},"closed":{"type":"integer","minimum":0},"overdue":{"type":"integer","minimum":0,"description":"Not yet published or closed and past the due date."}},"required":["open","in_progress","answered","published","rejected","closed","overdue"],"additionalProperties":false,"description":"Question counts per status among the questions the caller may read (QA-09)."},"quota":{"type":"object","nullable":true,"properties":{"groupId":{"type":"string","format":"uuid"},"groupName":{"type":"string","nullable":true},"limit":{"type":"integer","nullable":true,"minimum":0,"description":"null = no limit."},"used":{"type":"integer","minimum":0}},"required":["groupId","groupName","limit","used"],"additionalProperties":false},"settings":{"type":"object","nullable":true,"properties":{"defaultQuestionLimit":{"type":"integer","nullable":true,"minimum":0},"notifyEmail":{"type":"string","nullable":true,"description":"The deal team's notification address (firm-controlled)."},"revision":{"type":"integer","minimum":1},"groups":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true,"description":"Group name as the firm entered it."},"kind":{"type":"string","enum":["client","counterparty","expert","custom_external"]},"questionLimit":{"type":"integer","nullable":true,"minimum":0,"description":"Quota override; null = room default."},"asked":{"type":"integer","minimum":0,"description":"Questions asked by this group so far."}},"required":["groupId","name","kind","questionLimit","asked"],"additionalProperties":false,"description":"An external group of the room that may ask questions."}}},"required":["defaultQuestionLimit","notifyEmail","revision","groups"],"additionalProperties":false},"experts":{"type":"array","items":{"type":"object","properties":{"principalId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true,"description":"Display name, or null when none is set."}},"required":["principalId","name"],"additionalProperties":false,"description":"An internal member of the room who may draft answers."}},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":60},"colour":{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Colour as lowercase `#rrggbb`."},"sortOrder":{"type":"integer","minimum":0},"questionCount":{"type":"integer","minimum":0,"description":"Questions carrying this category (as the caller may read them)."}},"required":["id","name","colour","sortOrder","questionCount"],"additionalProperties":false,"description":"A room-specific question category."}}},"required":["enabled","role","counts","quota","settings","experts","categories"],"additionalProperties":false,"description":"Q&A overview of a room for the caller."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or question, Q&A not enabled, no access, or a question of another bidder group (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/qa/settings":{"put":{"operationId":"updateRoomQaSettings","summary":"Switch Q&A on or off and set quotas and the notification address","description":"qa.manage on the room (internal manage, not in a frozen/closed/archived room). Changeable while the room runs (QA-05); audited as qa.settings_changed with setting codes only.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"defaultQuestionLimit":{"type":"integer","nullable":true,"minimum":0,"maximum":10000},"notifyEmail":{"type":"string","nullable":true,"maxLength":320,"format":"email"},"groupLimits":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":"string","format":"uuid"},"questionLimit":{"type":"integer","nullable":true,"minimum":0,"maximum":10000}},"required":["groupId","questionLimit"],"additionalProperties":false},"maxItems":200},"revision":{"type":"integer","nullable":true,"minimum":1,"description":"Revision last read; null when creating."}},"required":["enabled","defaultQuestionLimit","notifyEmail","groupLimits","revision"],"additionalProperties":false,"description":"Switch Q&A on or off and set the quotas and notification address (QA-05, QA-07)."}}}},"responses":{"200":{"description":"Overview.","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"role":{"type":"string","enum":["coordinator","expert","observer","bidder"],"description":"coordinator = qa.manage, expert = qa.answer, observer = internal read only, bidder = guest of an external group."},"counts":{"type":"object","properties":{"open":{"type":"integer","minimum":0},"in_progress":{"type":"integer","minimum":0},"answered":{"type":"integer","minimum":0},"published":{"type":"integer","minimum":0},"rejected":{"type":"integer","minimum":0},"closed":{"type":"integer","minimum":0},"overdue":{"type":"integer","minimum":0,"description":"Not yet published or closed and past the due date."}},"required":["open","in_progress","answered","published","rejected","closed","overdue"],"additionalProperties":false,"description":"Question counts per status among the questions the caller may read (QA-09)."},"quota":{"type":"object","nullable":true,"properties":{"groupId":{"type":"string","format":"uuid"},"groupName":{"type":"string","nullable":true},"limit":{"type":"integer","nullable":true,"minimum":0,"description":"null = no limit."},"used":{"type":"integer","minimum":0}},"required":["groupId","groupName","limit","used"],"additionalProperties":false},"settings":{"type":"object","nullable":true,"properties":{"defaultQuestionLimit":{"type":"integer","nullable":true,"minimum":0},"notifyEmail":{"type":"string","nullable":true,"description":"The deal team's notification address (firm-controlled)."},"revision":{"type":"integer","minimum":1},"groups":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true,"description":"Group name as the firm entered it."},"kind":{"type":"string","enum":["client","counterparty","expert","custom_external"]},"questionLimit":{"type":"integer","nullable":true,"minimum":0,"description":"Quota override; null = room default."},"asked":{"type":"integer","minimum":0,"description":"Questions asked by this group so far."}},"required":["groupId","name","kind","questionLimit","asked"],"additionalProperties":false,"description":"An external group of the room that may ask questions."}}},"required":["defaultQuestionLimit","notifyEmail","revision","groups"],"additionalProperties":false},"experts":{"type":"array","items":{"type":"object","properties":{"principalId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true,"description":"Display name, or null when none is set."}},"required":["principalId","name"],"additionalProperties":false,"description":"An internal member of the room who may draft answers."}},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":60},"colour":{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Colour as lowercase `#rrggbb`."},"sortOrder":{"type":"integer","minimum":0},"questionCount":{"type":"integer","minimum":0,"description":"Questions carrying this category (as the caller may read them)."}},"required":["id","name","colour","sortOrder","questionCount"],"additionalProperties":false,"description":"A room-specific question category."}}},"required":["enabled","role","counts","quota","settings","experts","categories"],"additionalProperties":false,"description":"Q&A overview of a room for the caller."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (the caller lacks the Q&A role, or the room is not active).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or question, Q&A not enabled, no access, or a question of another bidder group (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"CONFLICT: the question or settings changed, the status does not allow this, or QUOTA_EXCEEDED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/qa/questions":{"get":{"operationId":"listRoomQaQuestions","summary":"List the questions the caller may read","description":"qa.read on the room. Internal members read every question; a bidder only its own group’s questions plus the published FAQ (without the asking group, asker or document link). Newest first with a keyset cursor; `truncated` is true when the cap holds more questions than were returned, so a capped list is never mistaken for the whole list.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","enum":["open","in_progress","answered","published","rejected","closed"],"description":"open = new, in_progress = routed to an expert, answered = answer awaits approval, published = answer released, rejected = declined by the coordinator with a reason (QA-13), closed."},"required":false,"description":"open = new, in_progress = routed to an expert, answered = answer awaits approval, published = answer released, rejected = declined by the coordinator with a reason (QA-13), closed.","name":"status","in":"query"},{"schema":{"type":"string","enum":["general","legal","financial","tax","commercial","hr","it","real_estate","environmental","other"],"description":"Question category (due-diligence workstream)."},"required":false,"description":"Question category (due-diligence workstream).","name":"category","in":"query"},{"schema":{"type":"string","enum":["low","normal","high"],"description":"Question priority."},"required":false,"description":"Question priority.","name":"priority","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"groupId","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"faq","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"nodeId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Room-specific category."},"required":false,"description":"Room-specific category.","name":"categoryId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Routed expert (internal readers only)."},"required":false,"description":"Routed expert (internal readers only).","name":"assigneeId","in":"query"},{"schema":{"type":"string","enum":["true"],"description":"Only overdue questions (internal readers only)."},"required":false,"description":"Only overdue questions (internal readers only).","name":"overdue","in":"query"},{"schema":{"type":"string","maxLength":512,"description":"Opaque keyset cursor from the previous page; omit it for the newest page."},"required":false,"description":"Opaque keyset cursor from the previous page; omit it for the newest page.","name":"cursor","in":"query"}],"responses":{"200":{"description":"Questions with an explicit partial signal.","content":{"application/json":{"schema":{"type":"object","properties":{"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"integer","nullable":true,"minimum":1,"description":"Number within the asking group; null for FAQ of another group."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Asking group; null for a bidder reading another group’s FAQ."},"groupName":{"type":"string","nullable":true},"ownGroup":{"type":"boolean","description":"The caller is a member of the asking group."},"subject":{"type":"string","nullable":true,"description":"Question subject (client data); null only after scrubbing."},"category":{"type":"string","enum":["general","legal","financial","tax","commercial","hr","it","real_estate","environmental","other"],"description":"Question category (due-diligence workstream)."},"categoryId":{"type":"string","nullable":true,"format":"uuid","description":"Room-specific category (QA-08); null when none."},"categoryName":{"type":"string","nullable":true},"categoryColour":{"type":"string","nullable":true,"pattern":"^#[0-9a-f]{6}$","description":"Colour as lowercase `#rrggbb`."},"priority":{"type":"string","enum":["low","normal","high"],"description":"Question priority."},"status":{"type":"string","enum":["open","in_progress","answered","published","rejected","closed"],"description":"open = new, in_progress = routed to an expert, answered = answer awaits approval, published = answer released, rejected = declined by the coordinator with a reason (QA-13), closed."},"faq":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date"},"overdue":{"type":"boolean"},"assigneeId":{"type":"string","nullable":true,"format":"uuid"},"assigneeName":{"type":"string","nullable":true},"nodeId":{"type":"string","nullable":true,"format":"uuid","description":"Linked document or folder; null when none or not shown."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Document of the linked node (opens the viewer); null for a folder or when not shown."},"pageNo":{"type":"integer","nullable":true,"minimum":1},"answerState":{"type":"string","enum":["none","draft","submitted","approved","rejected"],"description":"State of the latest answer of a question (bidders only ever see none or approved)."},"askedAt":{"type":"string","format":"date-time"},"publishedAt":{"type":"string","nullable":true,"format":"date-time"},"revision":{"type":"integer","minimum":1}},"required":["id","number","groupId","groupName","ownGroup","subject","category","categoryId","categoryName","categoryColour","priority","status","faq","dueDate","overdue","assigneeId","assigneeName","nodeId","documentId","pageNo","answerState","askedAt","publishedAt","revision"],"additionalProperties":false,"description":"A Q&A question as listed for the caller."},"description":"Questions the caller may read, newest first."},"truncated":{"type":"boolean","description":"True when more questions exist than were returned (the list is partial)."},"nextCursor":{"type":"string","nullable":true,"description":"Opaque cursor for the next (older) page; null on the last page."}},"required":["questions","truncated","nextCursor"],"additionalProperties":false,"description":"Questions the caller may read, newest first with an explicit partial signal."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or question, Q&A not enabled, no access, or a question of another bidder group (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"post":{"operationId":"askRoomQaQuestion","summary":"Ask a question","description":"A bidder asks for its own group (qa.ask); a coordinator records a question for a bidder group (qa.manage). A linked node must be visible to the caller (node.read). The group quota applies (409 QUOTA_EXCEEDED). Audited as qa_question.asked; the deal team gets a content-free e-mail.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"subject":{"type":"string","minLength":1,"maxLength":200},"body":{"type":"string","minLength":1,"maxLength":10000},"category":{"type":"string","enum":["general","legal","financial","tax","commercial","hr","it","real_estate","environmental","other"],"description":"Question category (due-diligence workstream)."},"categoryId":{"type":"string","nullable":true,"format":"uuid","description":"Room-specific category (QA-08)."},"priority":{"type":"string","enum":["low","normal","high"],"description":"Question priority."},"nodeId":{"type":"string","nullable":true,"format":"uuid"},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Instead of nodeId: the document open in the viewer; the server resolves its index node."},"pageNo":{"type":"integer","nullable":true,"minimum":1,"maximum":100000},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Coordinators recording a question for a bidder group; bidders leave it null (own group)."}},"required":["subject","body","category","priority","nodeId","pageNo","groupId"],"additionalProperties":false,"description":"Ask a question (QA-01), optionally about a document or folder and a page."}}}},"responses":{"201":{"description":"The question with its thread as the caller may read it.","content":{"application/json":{"schema":{"type":"object","properties":{"question":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"integer","nullable":true,"minimum":1,"description":"Number within the asking group; null for FAQ of another group."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Asking group; null for a bidder reading another group’s FAQ."},"groupName":{"type":"string","nullable":true},"ownGroup":{"type":"boolean","description":"The caller is a member of the asking group."},"subject":{"type":"string","nullable":true,"description":"Question subject (client data); null only after scrubbing."},"category":{"type":"string","enum":["general","legal","financial","tax","commercial","hr","it","real_estate","environmental","other"],"description":"Question category (due-diligence workstream)."},"categoryId":{"type":"string","nullable":true,"format":"uuid","description":"Room-specific category (QA-08); null when none."},"categoryName":{"type":"string","nullable":true},"categoryColour":{"type":"string","nullable":true,"pattern":"^#[0-9a-f]{6}$","description":"Colour as lowercase `#rrggbb`."},"priority":{"type":"string","enum":["low","normal","high"],"description":"Question priority."},"status":{"type":"string","enum":["open","in_progress","answered","published","rejected","closed"],"description":"open = new, in_progress = routed to an expert, answered = answer awaits approval, published = answer released, rejected = declined by the coordinator with a reason (QA-13), closed."},"faq":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date"},"overdue":{"type":"boolean"},"assigneeId":{"type":"string","nullable":true,"format":"uuid"},"assigneeName":{"type":"string","nullable":true},"nodeId":{"type":"string","nullable":true,"format":"uuid","description":"Linked document or folder; null when none or not shown."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Document of the linked node (opens the viewer); null for a folder or when not shown."},"pageNo":{"type":"integer","nullable":true,"minimum":1},"answerState":{"type":"string","enum":["none","draft","submitted","approved","rejected"],"description":"State of the latest answer of a question (bidders only ever see none or approved)."},"askedAt":{"type":"string","format":"date-time"},"publishedAt":{"type":"string","nullable":true,"format":"date-time"},"revision":{"type":"integer","minimum":1}},"required":["id","number","groupId","groupName","ownGroup","subject","category","categoryId","categoryName","categoryColour","priority","status","faq","dueDate","overdue","assigneeId","assigneeName","nodeId","documentId","pageNo","answerState","askedAt","publishedAt","revision"],"additionalProperties":false,"description":"A Q&A question as listed for the caller."},"body":{"type":"string","nullable":true,"description":"Question text (client data)."},"askedByName":{"type":"string","nullable":true,"description":"Internal readers and the asking group only."},"linkTitle":{"type":"string","nullable":true,"description":"Title of the linked node when the caller may read it (node.read); otherwise null."},"onBehalf":{"type":"boolean","description":"Recorded by the coordinator for the group (e.g. received by e-mail)."},"rejectionReason":{"type":"string","nullable":true,"description":"Why the coordinator declined the question (QA-13); the asking group reads it too."},"entries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["answer","note"]},"state":{"type":"string","enum":["draft","submitted","approved","rejected","posted"]},"body":{"type":"string","nullable":true,"description":"Answer or note text (client data)."},"authorId":{"type":"string","nullable":true,"format":"uuid","description":"Null for bidders."},"authorName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"decidedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","kind","state","body","authorId","authorName","createdAt","updatedAt","decidedAt"],"additionalProperties":false,"description":"One entry of a question thread. Bidders only receive approved answers."}},"can":{"type":"object","properties":{"answer":{"type":"boolean"},"manage":{"type":"boolean"},"publish":{"type":"boolean","description":"A submitted answer awaits approval and the caller coordinates."}},"required":["answer","manage","publish"],"additionalProperties":false}},"required":["question","body","askedByName","linkTitle","onBehalf","rejectionReason","entries","can"],"additionalProperties":false,"description":"A question with its thread, as the caller may read it."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (the caller lacks the Q&A role, or the room is not active).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or question, Q&A not enabled, no access, or a question of another bidder group (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"CONFLICT: the question or settings changed, the status does not allow this, or QUOTA_EXCEEDED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/qa/questions/{questionId}":{"get":{"operationId":"getRoomQaQuestion","summary":"Read one question with its thread","description":"qa.read on the room plus row visibility (another bidder group’s unpublished question is 404). Bidders receive only approved answers; notes and drafts stay internal. Audited as qa_question.viewed.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Question id."},"required":true,"description":"Question id.","name":"questionId","in":"path"}],"responses":{"200":{"description":"The question with its thread as the caller may read it.","content":{"application/json":{"schema":{"type":"object","properties":{"question":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"integer","nullable":true,"minimum":1,"description":"Number within the asking group; null for FAQ of another group."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Asking group; null for a bidder reading another group’s FAQ."},"groupName":{"type":"string","nullable":true},"ownGroup":{"type":"boolean","description":"The caller is a member of the asking group."},"subject":{"type":"string","nullable":true,"description":"Question subject (client data); null only after scrubbing."},"category":{"type":"string","enum":["general","legal","financial","tax","commercial","hr","it","real_estate","environmental","other"],"description":"Question category (due-diligence workstream)."},"categoryId":{"type":"string","nullable":true,"format":"uuid","description":"Room-specific category (QA-08); null when none."},"categoryName":{"type":"string","nullable":true},"categoryColour":{"type":"string","nullable":true,"pattern":"^#[0-9a-f]{6}$","description":"Colour as lowercase `#rrggbb`."},"priority":{"type":"string","enum":["low","normal","high"],"description":"Question priority."},"status":{"type":"string","enum":["open","in_progress","answered","published","rejected","closed"],"description":"open = new, in_progress = routed to an expert, answered = answer awaits approval, published = answer released, rejected = declined by the coordinator with a reason (QA-13), closed."},"faq":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date"},"overdue":{"type":"boolean"},"assigneeId":{"type":"string","nullable":true,"format":"uuid"},"assigneeName":{"type":"string","nullable":true},"nodeId":{"type":"string","nullable":true,"format":"uuid","description":"Linked document or folder; null when none or not shown."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Document of the linked node (opens the viewer); null for a folder or when not shown."},"pageNo":{"type":"integer","nullable":true,"minimum":1},"answerState":{"type":"string","enum":["none","draft","submitted","approved","rejected"],"description":"State of the latest answer of a question (bidders only ever see none or approved)."},"askedAt":{"type":"string","format":"date-time"},"publishedAt":{"type":"string","nullable":true,"format":"date-time"},"revision":{"type":"integer","minimum":1}},"required":["id","number","groupId","groupName","ownGroup","subject","category","categoryId","categoryName","categoryColour","priority","status","faq","dueDate","overdue","assigneeId","assigneeName","nodeId","documentId","pageNo","answerState","askedAt","publishedAt","revision"],"additionalProperties":false,"description":"A Q&A question as listed for the caller."},"body":{"type":"string","nullable":true,"description":"Question text (client data)."},"askedByName":{"type":"string","nullable":true,"description":"Internal readers and the asking group only."},"linkTitle":{"type":"string","nullable":true,"description":"Title of the linked node when the caller may read it (node.read); otherwise null."},"onBehalf":{"type":"boolean","description":"Recorded by the coordinator for the group (e.g. received by e-mail)."},"rejectionReason":{"type":"string","nullable":true,"description":"Why the coordinator declined the question (QA-13); the asking group reads it too."},"entries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["answer","note"]},"state":{"type":"string","enum":["draft","submitted","approved","rejected","posted"]},"body":{"type":"string","nullable":true,"description":"Answer or note text (client data)."},"authorId":{"type":"string","nullable":true,"format":"uuid","description":"Null for bidders."},"authorName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"decidedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","kind","state","body","authorId","authorName","createdAt","updatedAt","decidedAt"],"additionalProperties":false,"description":"One entry of a question thread. Bidders only receive approved answers."}},"can":{"type":"object","properties":{"answer":{"type":"boolean"},"manage":{"type":"boolean"},"publish":{"type":"boolean","description":"A submitted answer awaits approval and the caller coordinates."}},"required":["answer","manage","publish"],"additionalProperties":false}},"required":["question","body","askedByName","linkTitle","onBehalf","rejectionReason","entries","can"],"additionalProperties":false,"description":"A question with its thread, as the caller may read it."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or question, Q&A not enabled, no access, or a question of another bidder group (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"patch":{"operationId":"updateRoomQaQuestion","summary":"Route, prioritise, categorise, set a due date, close or reopen","description":"qa.manage on the room. Audited as qa_question.updated with field codes only.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Question id."},"required":true,"description":"Question id.","name":"questionId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"revision":{"type":"integer","minimum":1},"assigneeId":{"type":"string","nullable":true,"format":"uuid","description":"Route to an expert; null removes the routing."},"category":{"type":"string","enum":["general","legal","financial","tax","commercial","hr","it","real_estate","environmental","other"],"description":"Question category (due-diligence workstream)."},"categoryId":{"type":"string","nullable":true,"format":"uuid","description":"Room-specific category; null removes it."},"priority":{"type":"string","enum":["low","normal","high"],"description":"Question priority."},"dueDate":{"type":"string","nullable":true,"format":"date"},"status":{"type":"string","enum":["closed","reopened"],"description":"Close, or reopen a closed or rejected question."}},"required":["revision"],"additionalProperties":false,"description":"Coordinator changes to a question (QA-02, QA-08, QA-09)."}}}},"responses":{"200":{"description":"The question with its thread as the caller may read it.","content":{"application/json":{"schema":{"type":"object","properties":{"question":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"integer","nullable":true,"minimum":1,"description":"Number within the asking group; null for FAQ of another group."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Asking group; null for a bidder reading another group’s FAQ."},"groupName":{"type":"string","nullable":true},"ownGroup":{"type":"boolean","description":"The caller is a member of the asking group."},"subject":{"type":"string","nullable":true,"description":"Question subject (client data); null only after scrubbing."},"category":{"type":"string","enum":["general","legal","financial","tax","commercial","hr","it","real_estate","environmental","other"],"description":"Question category (due-diligence workstream)."},"categoryId":{"type":"string","nullable":true,"format":"uuid","description":"Room-specific category (QA-08); null when none."},"categoryName":{"type":"string","nullable":true},"categoryColour":{"type":"string","nullable":true,"pattern":"^#[0-9a-f]{6}$","description":"Colour as lowercase `#rrggbb`."},"priority":{"type":"string","enum":["low","normal","high"],"description":"Question priority."},"status":{"type":"string","enum":["open","in_progress","answered","published","rejected","closed"],"description":"open = new, in_progress = routed to an expert, answered = answer awaits approval, published = answer released, rejected = declined by the coordinator with a reason (QA-13), closed."},"faq":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date"},"overdue":{"type":"boolean"},"assigneeId":{"type":"string","nullable":true,"format":"uuid"},"assigneeName":{"type":"string","nullable":true},"nodeId":{"type":"string","nullable":true,"format":"uuid","description":"Linked document or folder; null when none or not shown."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Document of the linked node (opens the viewer); null for a folder or when not shown."},"pageNo":{"type":"integer","nullable":true,"minimum":1},"answerState":{"type":"string","enum":["none","draft","submitted","approved","rejected"],"description":"State of the latest answer of a question (bidders only ever see none or approved)."},"askedAt":{"type":"string","format":"date-time"},"publishedAt":{"type":"string","nullable":true,"format":"date-time"},"revision":{"type":"integer","minimum":1}},"required":["id","number","groupId","groupName","ownGroup","subject","category","categoryId","categoryName","categoryColour","priority","status","faq","dueDate","overdue","assigneeId","assigneeName","nodeId","documentId","pageNo","answerState","askedAt","publishedAt","revision"],"additionalProperties":false,"description":"A Q&A question as listed for the caller."},"body":{"type":"string","nullable":true,"description":"Question text (client data)."},"askedByName":{"type":"string","nullable":true,"description":"Internal readers and the asking group only."},"linkTitle":{"type":"string","nullable":true,"description":"Title of the linked node when the caller may read it (node.read); otherwise null."},"onBehalf":{"type":"boolean","description":"Recorded by the coordinator for the group (e.g. received by e-mail)."},"rejectionReason":{"type":"string","nullable":true,"description":"Why the coordinator declined the question (QA-13); the asking group reads it too."},"entries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["answer","note"]},"state":{"type":"string","enum":["draft","submitted","approved","rejected","posted"]},"body":{"type":"string","nullable":true,"description":"Answer or note text (client data)."},"authorId":{"type":"string","nullable":true,"format":"uuid","description":"Null for bidders."},"authorName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"decidedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","kind","state","body","authorId","authorName","createdAt","updatedAt","decidedAt"],"additionalProperties":false,"description":"One entry of a question thread. Bidders only receive approved answers."}},"can":{"type":"object","properties":{"answer":{"type":"boolean"},"manage":{"type":"boolean"},"publish":{"type":"boolean","description":"A submitted answer awaits approval and the caller coordinates."}},"required":["answer","manage","publish"],"additionalProperties":false}},"required":["question","body","askedByName","linkTitle","onBehalf","rejectionReason","entries","can"],"additionalProperties":false,"description":"A question with its thread, as the caller may read it."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (the caller lacks the Q&A role, or the room is not active).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or question, Q&A not enabled, no access, or a question of another bidder group (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"CONFLICT: the question or settings changed, the status does not allow this, or QUOTA_EXCEEDED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/qa/questions/{questionId}/answer":{"post":{"operationId":"saveRoomQaAnswer","summary":"Save or submit the answer draft","description":"qa.answer on the room, and the caller is the routed expert or coordinates. Audited as qa_answer.saved; a submission e-mails the deal team (content-free).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Question id."},"required":true,"description":"Question id.","name":"questionId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":10000},"submit":{"type":"boolean","description":"true = submit for approval; false = keep as draft."}},"required":["body","submit"],"additionalProperties":false,"description":"Save the answer draft of a question, optionally submitting it for approval."}}}},"responses":{"200":{"description":"The question with its thread as the caller may read it.","content":{"application/json":{"schema":{"type":"object","properties":{"question":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"integer","nullable":true,"minimum":1,"description":"Number within the asking group; null for FAQ of another group."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Asking group; null for a bidder reading another group’s FAQ."},"groupName":{"type":"string","nullable":true},"ownGroup":{"type":"boolean","description":"The caller is a member of the asking group."},"subject":{"type":"string","nullable":true,"description":"Question subject (client data); null only after scrubbing."},"category":{"type":"string","enum":["general","legal","financial","tax","commercial","hr","it","real_estate","environmental","other"],"description":"Question category (due-diligence workstream)."},"categoryId":{"type":"string","nullable":true,"format":"uuid","description":"Room-specific category (QA-08); null when none."},"categoryName":{"type":"string","nullable":true},"categoryColour":{"type":"string","nullable":true,"pattern":"^#[0-9a-f]{6}$","description":"Colour as lowercase `#rrggbb`."},"priority":{"type":"string","enum":["low","normal","high"],"description":"Question priority."},"status":{"type":"string","enum":["open","in_progress","answered","published","rejected","closed"],"description":"open = new, in_progress = routed to an expert, answered = answer awaits approval, published = answer released, rejected = declined by the coordinator with a reason (QA-13), closed."},"faq":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date"},"overdue":{"type":"boolean"},"assigneeId":{"type":"string","nullable":true,"format":"uuid"},"assigneeName":{"type":"string","nullable":true},"nodeId":{"type":"string","nullable":true,"format":"uuid","description":"Linked document or folder; null when none or not shown."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Document of the linked node (opens the viewer); null for a folder or when not shown."},"pageNo":{"type":"integer","nullable":true,"minimum":1},"answerState":{"type":"string","enum":["none","draft","submitted","approved","rejected"],"description":"State of the latest answer of a question (bidders only ever see none or approved)."},"askedAt":{"type":"string","format":"date-time"},"publishedAt":{"type":"string","nullable":true,"format":"date-time"},"revision":{"type":"integer","minimum":1}},"required":["id","number","groupId","groupName","ownGroup","subject","category","categoryId","categoryName","categoryColour","priority","status","faq","dueDate","overdue","assigneeId","assigneeName","nodeId","documentId","pageNo","answerState","askedAt","publishedAt","revision"],"additionalProperties":false,"description":"A Q&A question as listed for the caller."},"body":{"type":"string","nullable":true,"description":"Question text (client data)."},"askedByName":{"type":"string","nullable":true,"description":"Internal readers and the asking group only."},"linkTitle":{"type":"string","nullable":true,"description":"Title of the linked node when the caller may read it (node.read); otherwise null."},"onBehalf":{"type":"boolean","description":"Recorded by the coordinator for the group (e.g. received by e-mail)."},"rejectionReason":{"type":"string","nullable":true,"description":"Why the coordinator declined the question (QA-13); the asking group reads it too."},"entries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["answer","note"]},"state":{"type":"string","enum":["draft","submitted","approved","rejected","posted"]},"body":{"type":"string","nullable":true,"description":"Answer or note text (client data)."},"authorId":{"type":"string","nullable":true,"format":"uuid","description":"Null for bidders."},"authorName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"decidedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","kind","state","body","authorId","authorName","createdAt","updatedAt","decidedAt"],"additionalProperties":false,"description":"One entry of a question thread. Bidders only receive approved answers."}},"can":{"type":"object","properties":{"answer":{"type":"boolean"},"manage":{"type":"boolean"},"publish":{"type":"boolean","description":"A submitted answer awaits approval and the caller coordinates."}},"required":["answer","manage","publish"],"additionalProperties":false}},"required":["question","body","askedByName","linkTitle","onBehalf","rejectionReason","entries","can"],"additionalProperties":false,"description":"A question with its thread, as the caller may read it."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (the caller lacks the Q&A role, or the room is not active).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or question, Q&A not enabled, no access, or a question of another bidder group (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"CONFLICT: the question or settings changed, the status does not allow this, or QUOTA_EXCEEDED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/qa/questions/{questionId}/notes":{"post":{"operationId":"postRoomQaNote","summary":"Post an internal note","description":"qa.answer on the room. Never visible to bidders. Audited as qa_note.posted.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Question id."},"required":true,"description":"Question id.","name":"questionId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":10000}},"required":["body"],"additionalProperties":false,"description":"Post an internal note (never visible to bidders)."}}}},"responses":{"200":{"description":"The question with its thread as the caller may read it.","content":{"application/json":{"schema":{"type":"object","properties":{"question":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"integer","nullable":true,"minimum":1,"description":"Number within the asking group; null for FAQ of another group."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Asking group; null for a bidder reading another group’s FAQ."},"groupName":{"type":"string","nullable":true},"ownGroup":{"type":"boolean","description":"The caller is a member of the asking group."},"subject":{"type":"string","nullable":true,"description":"Question subject (client data); null only after scrubbing."},"category":{"type":"string","enum":["general","legal","financial","tax","commercial","hr","it","real_estate","environmental","other"],"description":"Question category (due-diligence workstream)."},"categoryId":{"type":"string","nullable":true,"format":"uuid","description":"Room-specific category (QA-08); null when none."},"categoryName":{"type":"string","nullable":true},"categoryColour":{"type":"string","nullable":true,"pattern":"^#[0-9a-f]{6}$","description":"Colour as lowercase `#rrggbb`."},"priority":{"type":"string","enum":["low","normal","high"],"description":"Question priority."},"status":{"type":"string","enum":["open","in_progress","answered","published","rejected","closed"],"description":"open = new, in_progress = routed to an expert, answered = answer awaits approval, published = answer released, rejected = declined by the coordinator with a reason (QA-13), closed."},"faq":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date"},"overdue":{"type":"boolean"},"assigneeId":{"type":"string","nullable":true,"format":"uuid"},"assigneeName":{"type":"string","nullable":true},"nodeId":{"type":"string","nullable":true,"format":"uuid","description":"Linked document or folder; null when none or not shown."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Document of the linked node (opens the viewer); null for a folder or when not shown."},"pageNo":{"type":"integer","nullable":true,"minimum":1},"answerState":{"type":"string","enum":["none","draft","submitted","approved","rejected"],"description":"State of the latest answer of a question (bidders only ever see none or approved)."},"askedAt":{"type":"string","format":"date-time"},"publishedAt":{"type":"string","nullable":true,"format":"date-time"},"revision":{"type":"integer","minimum":1}},"required":["id","number","groupId","groupName","ownGroup","subject","category","categoryId","categoryName","categoryColour","priority","status","faq","dueDate","overdue","assigneeId","assigneeName","nodeId","documentId","pageNo","answerState","askedAt","publishedAt","revision"],"additionalProperties":false,"description":"A Q&A question as listed for the caller."},"body":{"type":"string","nullable":true,"description":"Question text (client data)."},"askedByName":{"type":"string","nullable":true,"description":"Internal readers and the asking group only."},"linkTitle":{"type":"string","nullable":true,"description":"Title of the linked node when the caller may read it (node.read); otherwise null."},"onBehalf":{"type":"boolean","description":"Recorded by the coordinator for the group (e.g. received by e-mail)."},"rejectionReason":{"type":"string","nullable":true,"description":"Why the coordinator declined the question (QA-13); the asking group reads it too."},"entries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["answer","note"]},"state":{"type":"string","enum":["draft","submitted","approved","rejected","posted"]},"body":{"type":"string","nullable":true,"description":"Answer or note text (client data)."},"authorId":{"type":"string","nullable":true,"format":"uuid","description":"Null for bidders."},"authorName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"decidedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","kind","state","body","authorId","authorName","createdAt","updatedAt","decidedAt"],"additionalProperties":false,"description":"One entry of a question thread. Bidders only receive approved answers."}},"can":{"type":"object","properties":{"answer":{"type":"boolean"},"manage":{"type":"boolean"},"publish":{"type":"boolean","description":"A submitted answer awaits approval and the caller coordinates."}},"required":["answer","manage","publish"],"additionalProperties":false}},"required":["question","body","askedByName","linkTitle","onBehalf","rejectionReason","entries","can"],"additionalProperties":false,"description":"A question with its thread, as the caller may read it."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (the caller lacks the Q&A role, or the room is not active).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or question, Q&A not enabled, no access, or a question of another bidder group (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/qa/questions/{questionId}/publish":{"post":{"operationId":"publishRoomQaAnswer","summary":"Approve the submitted answer and publish it","description":"qa.manage on the room: the single approval step (QA-12). Publishes to the asking group, or to every bidder as anonymised FAQ. Audited as qa_question.published; the bidders who can read it get a content-free e-mail.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Question id."},"required":true,"description":"Question id.","name":"questionId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"faq":{"type":"boolean","description":"true = publish to every bidder as anonymised FAQ; false = asking group only."}},"required":["faq"],"additionalProperties":false,"description":"Approve the submitted answer and publish it (QA-04/QA-12 approval step, QA-06)."}}}},"responses":{"200":{"description":"The question with its thread as the caller may read it.","content":{"application/json":{"schema":{"type":"object","properties":{"question":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"integer","nullable":true,"minimum":1,"description":"Number within the asking group; null for FAQ of another group."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Asking group; null for a bidder reading another group’s FAQ."},"groupName":{"type":"string","nullable":true},"ownGroup":{"type":"boolean","description":"The caller is a member of the asking group."},"subject":{"type":"string","nullable":true,"description":"Question subject (client data); null only after scrubbing."},"category":{"type":"string","enum":["general","legal","financial","tax","commercial","hr","it","real_estate","environmental","other"],"description":"Question category (due-diligence workstream)."},"categoryId":{"type":"string","nullable":true,"format":"uuid","description":"Room-specific category (QA-08); null when none."},"categoryName":{"type":"string","nullable":true},"categoryColour":{"type":"string","nullable":true,"pattern":"^#[0-9a-f]{6}$","description":"Colour as lowercase `#rrggbb`."},"priority":{"type":"string","enum":["low","normal","high"],"description":"Question priority."},"status":{"type":"string","enum":["open","in_progress","answered","published","rejected","closed"],"description":"open = new, in_progress = routed to an expert, answered = answer awaits approval, published = answer released, rejected = declined by the coordinator with a reason (QA-13), closed."},"faq":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date"},"overdue":{"type":"boolean"},"assigneeId":{"type":"string","nullable":true,"format":"uuid"},"assigneeName":{"type":"string","nullable":true},"nodeId":{"type":"string","nullable":true,"format":"uuid","description":"Linked document or folder; null when none or not shown."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Document of the linked node (opens the viewer); null for a folder or when not shown."},"pageNo":{"type":"integer","nullable":true,"minimum":1},"answerState":{"type":"string","enum":["none","draft","submitted","approved","rejected"],"description":"State of the latest answer of a question (bidders only ever see none or approved)."},"askedAt":{"type":"string","format":"date-time"},"publishedAt":{"type":"string","nullable":true,"format":"date-time"},"revision":{"type":"integer","minimum":1}},"required":["id","number","groupId","groupName","ownGroup","subject","category","categoryId","categoryName","categoryColour","priority","status","faq","dueDate","overdue","assigneeId","assigneeName","nodeId","documentId","pageNo","answerState","askedAt","publishedAt","revision"],"additionalProperties":false,"description":"A Q&A question as listed for the caller."},"body":{"type":"string","nullable":true,"description":"Question text (client data)."},"askedByName":{"type":"string","nullable":true,"description":"Internal readers and the asking group only."},"linkTitle":{"type":"string","nullable":true,"description":"Title of the linked node when the caller may read it (node.read); otherwise null."},"onBehalf":{"type":"boolean","description":"Recorded by the coordinator for the group (e.g. received by e-mail)."},"rejectionReason":{"type":"string","nullable":true,"description":"Why the coordinator declined the question (QA-13); the asking group reads it too."},"entries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["answer","note"]},"state":{"type":"string","enum":["draft","submitted","approved","rejected","posted"]},"body":{"type":"string","nullable":true,"description":"Answer or note text (client data)."},"authorId":{"type":"string","nullable":true,"format":"uuid","description":"Null for bidders."},"authorName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"decidedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","kind","state","body","authorId","authorName","createdAt","updatedAt","decidedAt"],"additionalProperties":false,"description":"One entry of a question thread. Bidders only receive approved answers."}},"can":{"type":"object","properties":{"answer":{"type":"boolean"},"manage":{"type":"boolean"},"publish":{"type":"boolean","description":"A submitted answer awaits approval and the caller coordinates."}},"required":["answer","manage","publish"],"additionalProperties":false}},"required":["question","body","askedByName","linkTitle","onBehalf","rejectionReason","entries","can"],"additionalProperties":false,"description":"A question with its thread, as the caller may read it."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (the caller lacks the Q&A role, or the room is not active).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or question, Q&A not enabled, no access, or a question of another bidder group (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"CONFLICT: the question or settings changed, the status does not allow this, or QUOTA_EXCEEDED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/qa/questions/{questionId}/reject":{"post":{"operationId":"rejectRoomQaAnswer","summary":"Send the submitted answer back to the expert","description":"qa.manage on the room. Audited as qa_answer.rejected.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Question id."},"required":true,"description":"Question id.","name":"questionId","in":"path"}],"responses":{"200":{"description":"The question with its thread as the caller may read it.","content":{"application/json":{"schema":{"type":"object","properties":{"question":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"integer","nullable":true,"minimum":1,"description":"Number within the asking group; null for FAQ of another group."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Asking group; null for a bidder reading another group’s FAQ."},"groupName":{"type":"string","nullable":true},"ownGroup":{"type":"boolean","description":"The caller is a member of the asking group."},"subject":{"type":"string","nullable":true,"description":"Question subject (client data); null only after scrubbing."},"category":{"type":"string","enum":["general","legal","financial","tax","commercial","hr","it","real_estate","environmental","other"],"description":"Question category (due-diligence workstream)."},"categoryId":{"type":"string","nullable":true,"format":"uuid","description":"Room-specific category (QA-08); null when none."},"categoryName":{"type":"string","nullable":true},"categoryColour":{"type":"string","nullable":true,"pattern":"^#[0-9a-f]{6}$","description":"Colour as lowercase `#rrggbb`."},"priority":{"type":"string","enum":["low","normal","high"],"description":"Question priority."},"status":{"type":"string","enum":["open","in_progress","answered","published","rejected","closed"],"description":"open = new, in_progress = routed to an expert, answered = answer awaits approval, published = answer released, rejected = declined by the coordinator with a reason (QA-13), closed."},"faq":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date"},"overdue":{"type":"boolean"},"assigneeId":{"type":"string","nullable":true,"format":"uuid"},"assigneeName":{"type":"string","nullable":true},"nodeId":{"type":"string","nullable":true,"format":"uuid","description":"Linked document or folder; null when none or not shown."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Document of the linked node (opens the viewer); null for a folder or when not shown."},"pageNo":{"type":"integer","nullable":true,"minimum":1},"answerState":{"type":"string","enum":["none","draft","submitted","approved","rejected"],"description":"State of the latest answer of a question (bidders only ever see none or approved)."},"askedAt":{"type":"string","format":"date-time"},"publishedAt":{"type":"string","nullable":true,"format":"date-time"},"revision":{"type":"integer","minimum":1}},"required":["id","number","groupId","groupName","ownGroup","subject","category","categoryId","categoryName","categoryColour","priority","status","faq","dueDate","overdue","assigneeId","assigneeName","nodeId","documentId","pageNo","answerState","askedAt","publishedAt","revision"],"additionalProperties":false,"description":"A Q&A question as listed for the caller."},"body":{"type":"string","nullable":true,"description":"Question text (client data)."},"askedByName":{"type":"string","nullable":true,"description":"Internal readers and the asking group only."},"linkTitle":{"type":"string","nullable":true,"description":"Title of the linked node when the caller may read it (node.read); otherwise null."},"onBehalf":{"type":"boolean","description":"Recorded by the coordinator for the group (e.g. received by e-mail)."},"rejectionReason":{"type":"string","nullable":true,"description":"Why the coordinator declined the question (QA-13); the asking group reads it too."},"entries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["answer","note"]},"state":{"type":"string","enum":["draft","submitted","approved","rejected","posted"]},"body":{"type":"string","nullable":true,"description":"Answer or note text (client data)."},"authorId":{"type":"string","nullable":true,"format":"uuid","description":"Null for bidders."},"authorName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"decidedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","kind","state","body","authorId","authorName","createdAt","updatedAt","decidedAt"],"additionalProperties":false,"description":"One entry of a question thread. Bidders only receive approved answers."}},"can":{"type":"object","properties":{"answer":{"type":"boolean"},"manage":{"type":"boolean"},"publish":{"type":"boolean","description":"A submitted answer awaits approval and the caller coordinates."}},"required":["answer","manage","publish"],"additionalProperties":false}},"required":["question","body","askedByName","linkTitle","onBehalf","rejectionReason","entries","can"],"additionalProperties":false,"description":"A question with its thread, as the caller may read it."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (the caller lacks the Q&A role, or the room is not active).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or question, Q&A not enabled, no access, or a question of another bidder group (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"CONFLICT: the question or settings changed, the status does not allow this, or QUOTA_EXCEEDED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/close":{"post":{"operationId":"closeRoom","summary":"Close a room and start its retention clock","description":"Moves an `active` or `frozen` room to `closed` (read-only), records the `room_closed` trigger with the server clock (never backdated), assigns the room-type default retention classes of the firm schedule and computes `retention_until` in the same transaction (ADR-0012 D3, D4). Decided on `room.close` (`manage` on the room root or `firm_admin`); writes `room.state_changed` and `retention.trigger_recorded`. 409 CONFLICT when the room is not active or frozen.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"The room retention surface after closing.","content":{"application/json":{"schema":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid","description":"Room id."},"state":{"type":"string","enum":["active","frozen","closed","archived"],"description":"Room state; closing starts the retention clock (ADR-0012 D3)."},"closedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the current `room_closed` trigger was recorded (the clock start), or null."},"retentionUntil":{"type":"string","nullable":true,"format":"date","description":"Room retention_until (Europe/Amsterdam date); null means no expiry yet."},"retentionFloor":{"type":"string","nullable":true,"format":"date","description":"Latest date ever computed for the room."},"retentionEvaluatedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the date was last recomputed."},"expired":{"type":"boolean","description":"True when today (Europe/Amsterdam) is after retention_until (ADR-0012 D1)."},"eligibleForDestruction":{"type":"boolean","description":"Closed or archived, expired, no hold (grace included) and no open procedure (D8.5)."},"recordClasses":{"type":"array","items":{"type":"object","properties":{"classId":{"type":"string","enum":["legal_file","legal_financial_record","legal_liability_long","wwft_cdd","mortgage_advice_file","mortgage_supporting","mortgage_identity_copy","general_room","notary_file","notary_environmental","accountancy_record","financial_advice_file","mifid_record","mediation_file","insolvency_estate"],"description":"Platform retention class id (ADR-0012 D2); tenants cannot create classes in the MVP."},"source":{"type":"string","enum":["room_type","manual"],"description":"How the class was assigned (append-only)."},"effectiveDuration":{"type":"string","pattern":"^P(?!$)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)W)?(?:(\\d+)D)?$","description":"Tenant duration of the class, or its default."},"assignedAt":{"type":"string","format":"date-time","description":"Assignment timestamp (UTC, ISO-8601)."},"assignedBy":{"type":"string","nullable":true,"format":"uuid","description":"Principal that assigned the class, or null for a rule."}},"required":["classId","source","effectiveDuration","assignedAt","assignedBy"],"additionalProperties":false,"description":"One class of the room records (ADR-0012 D4); append-only."},"description":"Classes of the room records (index, messages, notes), append-only."},"hold":{"type":"object","properties":{"active":{"type":"boolean","description":"True when at least one hold covers the item."},"holdCount":{"type":"integer","minimum":0,"description":"Number of holds that cover the item."},"graceEndsAt":{"type":"string","nullable":true,"format":"date-time","description":"Latest grace end of a lifted hold that still covers the item, or null."}},"required":["active","holdCount","graceEndsAt"],"additionalProperties":false,"description":"Hold-state projection on a retention surface; ids and dates only (ADR-0012 D7)."},"destruction":{"type":"object","nullable":true,"properties":{"requestId":{"type":"string","format":"uuid","description":"Deletion request id."},"status":{"type":"string","enum":["requested","approved","executing","completed","failed"],"description":"Deletion request status (ADR-0012 D10)."},"coolingOffUntil":{"type":"string","nullable":true,"format":"date-time","description":"End of the 72-hour cooling-off, or null."}},"required":["requestId","status","coolingOffUntil"],"additionalProperties":false,"description":"Open or completed destruction request."}},"required":["roomId","state","closedAt","retentionUntil","retentionFloor","retentionEvaluatedAt","expired","eligibleForDestruction","recordClasses","hold","destruction"],"additionalProperties":false,"description":"Retention surface of one room; ids, dates and codes only."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no firm_admin/compliance right, a guest or support session, or step-up required: 401 STEP_UP_REQUIRED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, hidden, or cross-tenant: the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Conflict (code CONFLICT); ADR-0012 D11.1 decision order, a hold is always reported first.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/retention/overview":{"get":{"operationId":"getRetentionOverview","summary":"Rooms nearing or past their retention date, and rooms on hold","description":"Closed and archived rooms with their retention date and days left, plus every room covered by a legal hold (grace included), soonest expiry first (RET-01, RET-02). `retention.overview.read`: firm_admin and compliance. Guests and support are refused.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"Retention overview.","content":{"application/json":{"schema":{"type":"object","properties":{"today":{"type":"string","format":"date","description":"Today in Europe/Amsterdam, the reference day of `daysLeft`."},"rooms":{"type":"array","items":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid","description":"Room id."},"name":{"type":"string","description":"Room name (firm admins and compliance read the room directory anyway)."},"type":{"type":"string","enum":["client_portal","litigation","mortgage_advice"],"description":"Room type."},"state":{"type":"string","enum":["active","frozen","closed","archived"],"description":"Room state; closing starts the retention clock (ADR-0012 D3)."},"closedAt":{"type":"string","nullable":true,"format":"date-time","description":"Clock start (`room_closed`), or null."},"retentionUntil":{"type":"string","nullable":true,"format":"date","description":"Room retention_until (Europe/Amsterdam), or null."},"daysLeft":{"type":"integer","nullable":true,"description":"Calendar days until retention_until (negative once expired), or null."},"expired":{"type":"boolean","description":"Today (Europe/Amsterdam) is after retention_until."},"eligibleForDestruction":{"type":"boolean","description":"Expired, closed or archived, no hold, no open procedure."},"hold":{"type":"object","properties":{"active":{"type":"boolean","description":"True when at least one hold covers the item."},"holdCount":{"type":"integer","minimum":0,"description":"Number of holds that cover the item."},"graceEndsAt":{"type":"string","nullable":true,"format":"date-time","description":"Latest grace end of a lifted hold that still covers the item, or null."}},"required":["active","holdCount","graceEndsAt"],"additionalProperties":false,"description":"Hold-state projection on a retention surface; ids and dates only (ADR-0012 D7)."},"destruction":{"type":"object","nullable":true,"properties":{"requestId":{"type":"string","format":"uuid","description":"Deletion request id."},"status":{"type":"string","enum":["requested","approved","executing","completed","failed"],"description":"Deletion request status (ADR-0012 D10)."},"coolingOffUntil":{"type":"string","nullable":true,"format":"date-time","description":"End of the 72-hour cooling-off, or null."}},"required":["requestId","status","coolingOffUntil"],"additionalProperties":false,"description":"The open or completed destruction request of the room."}},"required":["roomId","name","type","state","closedAt","retentionUntil","daysLeft","expired","eligibleForDestruction","hold","destruction"],"additionalProperties":false,"description":"One room in the retention overview; ids, dates, codes and the room name."},"description":"Closed or archived rooms and every room with a hold, soonest expiry first."}},"required":["today","rooms"],"description":"Firm retention overview (RET-01, RET-02)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no firm_admin/compliance right, a guest or support session, or step-up required: 401 STEP_UP_REQUIRED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, hidden, or cross-tenant: the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/destruction-requests":{"post":{"operationId":"requestRoomDestruction","summary":"Request the destruction of a closed, expired room","description":"Creates a `room_destruction` deletion request with an ids-and-counts plan and its SHA-256 (ADR-0012 D8.5, D10). `room.destruction.request`: firm_admin with step-up. Refused in the D11.1 order: 409 LEGAL_HOLD (a hold or a lift in its 7-day grace covers the room or its matter), ROOM_DESTROYING, ROOM_NOT_CLOSED, RETENTION_UNSET, RETENTION_NOT_EXPIRED, OPEN_PROCEDURES, CONFLICT (a request is already open). Needs a second, independent approval; when nobody else is eligible the request is approved with a 72-hour cooling-off instead. Writes `deletion_request.created`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["retention_expired","client_instruction","other"],"description":"Why the room is destroyed; the retention end is the normal reason."}},"required":["reasonCode"],"additionalProperties":false,"description":"Request the destruction of a closed, expired room (ADR-0012 D8.5)."}}}},"responses":{"201":{"description":"The created deletion request.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Deletion request id."},"kind":{"type":"string","enum":["room_destruction"],"description":"Request kind (this slice: room destruction only)."},"status":{"type":"string","enum":["requested","approved","executing","completed","rejected","cancelled","expired","failed"],"description":"Deletion request status (ADR-0012 D10), forward only."},"roomId":{"type":"string","format":"uuid","description":"Room id."},"roomName":{"type":"string","nullable":true,"description":"Room name while the room exists; null once it is destroyed (scrubbed)."},"reasonCode":{"type":"string","enum":["retention_expired","client_instruction","other"],"description":"Why the room is destroyed; the retention end is the normal reason."},"plan":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid","description":"Room id."},"retentionUntil":{"type":"string","format":"date","description":"The expired retention date the plan was made for."},"documents":{"type":"integer","minimum":0,"description":"Documents in the room."},"versions":{"type":"integer","minimum":0,"description":"Document versions in the room."},"blobs":{"type":"integer","minimum":0,"description":"Blobs whose data-key wrap will be destroyed."},"bytes":{"type":"integer","minimum":0,"description":"Plaintext bytes of those blobs."},"keyVersions":{"type":"integer","minimum":0,"description":"Room key versions that will be destroyed."},"holds":{"type":"integer","minimum":0,"description":"Holds covering the room (must be 0)."},"openProcedures":{"type":"integer","minimum":0,"description":"Procedures in the room (must be 0)."}},"required":["roomId","retentionUntil","documents","versions","blobs","bytes","keyVersions","holds","openProcedures"],"additionalProperties":false,"description":"Ids-and-counts plan of a room destruction (ADR-0012 D10)."},"planSha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the canonical plan JSON (hex)."},"approvalsRequired":{"type":"integer","minimum":1,"maximum":2,"description":"2 for room destruction (D8.5)."},"requestedBy":{"type":"string","nullable":true,"format":"uuid","description":"Requesting principal."},"requestedAt":{"type":"string","format":"date-time","description":"Request timestamp (UTC)."},"approvedBy":{"type":"string","nullable":true,"format":"uuid","description":"Second approver, or null (cooling-off or pending)."},"approvedAt":{"type":"string","nullable":true,"format":"date-time"},"coolingOffUntil":{"type":"string","nullable":true,"format":"date-time","description":"Set when nobody else was eligible: executes after this unless cancelled (D10)."},"expiresAt":{"type":"string","format":"date-time","description":"Request expiry (D10: 14 days)."},"executedAt":{"type":"string","nullable":true,"format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"deletionRecordId":{"type":"string","nullable":true,"format":"uuid","description":"Deletion record (certificate) once completed."},"failureCode":{"type":"string","nullable":true,"pattern":"^[A-Z][A-Z0-9_]{0,62}$","description":"Why the last execution attempt stopped, as a code."},"callerMayApprove":{"type":"boolean","description":"True when the caller is not the requester and the request awaits approval."}},"required":["id","kind","status","roomId","roomName","reasonCode","plan","planSha256","approvalsRequired","requestedBy","requestedAt","approvedBy","approvedAt","coolingOffUntil","expiresAt","executedAt","completedAt","deletionRecordId","failureCode","callerMayApprove"],"additionalProperties":false,"description":"One deletion request (ADR-0012 D10); no names except the room name while it exists."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no firm_admin/compliance right, a guest or support session, or step-up required: 401 STEP_UP_REQUIRED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, hidden, or cross-tenant: the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Conflict (code LEGAL_HOLD, ROOM_DESTROYING, ROOM_NOT_CLOSED, RETENTION_UNSET, RETENTION_NOT_EXPIRED, OPEN_PROCEDURES, CONFLICT); ADR-0012 D11.1 decision order, a hold is always reported first.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/deletion-requests":{"get":{"operationId":"listDeletionRequests","summary":"List deletion requests","description":"Every deletion request of the tenant, newest first, with its plan and hash (ADR-0012 D10). `deletion_request.read`: firm_admin and compliance.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"Deletion requests.","content":{"application/json":{"schema":{"type":"object","properties":{"requests":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Deletion request id."},"kind":{"type":"string","enum":["room_destruction"],"description":"Request kind (this slice: room destruction only)."},"status":{"type":"string","enum":["requested","approved","executing","completed","rejected","cancelled","expired","failed"],"description":"Deletion request status (ADR-0012 D10), forward only."},"roomId":{"type":"string","format":"uuid","description":"Room id."},"roomName":{"type":"string","nullable":true,"description":"Room name while the room exists; null once it is destroyed (scrubbed)."},"reasonCode":{"type":"string","enum":["retention_expired","client_instruction","other"],"description":"Why the room is destroyed; the retention end is the normal reason."},"plan":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid","description":"Room id."},"retentionUntil":{"type":"string","format":"date","description":"The expired retention date the plan was made for."},"documents":{"type":"integer","minimum":0,"description":"Documents in the room."},"versions":{"type":"integer","minimum":0,"description":"Document versions in the room."},"blobs":{"type":"integer","minimum":0,"description":"Blobs whose data-key wrap will be destroyed."},"bytes":{"type":"integer","minimum":0,"description":"Plaintext bytes of those blobs."},"keyVersions":{"type":"integer","minimum":0,"description":"Room key versions that will be destroyed."},"holds":{"type":"integer","minimum":0,"description":"Holds covering the room (must be 0)."},"openProcedures":{"type":"integer","minimum":0,"description":"Procedures in the room (must be 0)."}},"required":["roomId","retentionUntil","documents","versions","blobs","bytes","keyVersions","holds","openProcedures"],"additionalProperties":false,"description":"Ids-and-counts plan of a room destruction (ADR-0012 D10)."},"planSha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the canonical plan JSON (hex)."},"approvalsRequired":{"type":"integer","minimum":1,"maximum":2,"description":"2 for room destruction (D8.5)."},"requestedBy":{"type":"string","nullable":true,"format":"uuid","description":"Requesting principal."},"requestedAt":{"type":"string","format":"date-time","description":"Request timestamp (UTC)."},"approvedBy":{"type":"string","nullable":true,"format":"uuid","description":"Second approver, or null (cooling-off or pending)."},"approvedAt":{"type":"string","nullable":true,"format":"date-time"},"coolingOffUntil":{"type":"string","nullable":true,"format":"date-time","description":"Set when nobody else was eligible: executes after this unless cancelled (D10)."},"expiresAt":{"type":"string","format":"date-time","description":"Request expiry (D10: 14 days)."},"executedAt":{"type":"string","nullable":true,"format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"deletionRecordId":{"type":"string","nullable":true,"format":"uuid","description":"Deletion record (certificate) once completed."},"failureCode":{"type":"string","nullable":true,"pattern":"^[A-Z][A-Z0-9_]{0,62}$","description":"Why the last execution attempt stopped, as a code."},"callerMayApprove":{"type":"boolean","description":"True when the caller is not the requester and the request awaits approval."}},"required":["id","kind","status","roomId","roomName","reasonCode","plan","planSha256","approvalsRequired","requestedBy","requestedAt","approvedBy","approvedAt","coolingOffUntil","expiresAt","executedAt","completedAt","deletionRecordId","failureCode","callerMayApprove"],"additionalProperties":false,"description":"One deletion request (ADR-0012 D10); no names except the room name while it exists."},"description":"Newest first."}},"required":["requests"],"description":"Deletion requests of the tenant (ADR-0012 D10)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no firm_admin/compliance right, a guest or support session, or step-up required: 401 STEP_UP_REQUIRED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, hidden, or cross-tenant: the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/deletion-requests/{requestId}/approve":{"post":{"operationId":"approveDeletionRequest","summary":"Approve a deletion request as the second approver","description":"Four eyes (ADR-0012 D10): `deletion_request.approve` (firm_admin or compliance, step-up); never the requester (409 APPROVER_IS_REQUESTER); the approver must have held firm_admin or compliance for 7 days before the request (409 APPROVER_TENURE); the plan is recomputed and must hash to the approved `planSha256` (409 PLAN_CHANGED). A hold is re-checked first (409 LEGAL_HOLD). Writes `deletion_request.approved`; the worker then executes it.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Deletion request id."},"required":true,"description":"Deletion request id.","name":"requestId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"planSha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"The plan hash the approver saw (D10)."}},"required":["planSha256"],"additionalProperties":false,"description":"Approve the plan hash of a deletion request as the second approver."}}}},"responses":{"200":{"description":"The approved request.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Deletion request id."},"kind":{"type":"string","enum":["room_destruction"],"description":"Request kind (this slice: room destruction only)."},"status":{"type":"string","enum":["requested","approved","executing","completed","rejected","cancelled","expired","failed"],"description":"Deletion request status (ADR-0012 D10), forward only."},"roomId":{"type":"string","format":"uuid","description":"Room id."},"roomName":{"type":"string","nullable":true,"description":"Room name while the room exists; null once it is destroyed (scrubbed)."},"reasonCode":{"type":"string","enum":["retention_expired","client_instruction","other"],"description":"Why the room is destroyed; the retention end is the normal reason."},"plan":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid","description":"Room id."},"retentionUntil":{"type":"string","format":"date","description":"The expired retention date the plan was made for."},"documents":{"type":"integer","minimum":0,"description":"Documents in the room."},"versions":{"type":"integer","minimum":0,"description":"Document versions in the room."},"blobs":{"type":"integer","minimum":0,"description":"Blobs whose data-key wrap will be destroyed."},"bytes":{"type":"integer","minimum":0,"description":"Plaintext bytes of those blobs."},"keyVersions":{"type":"integer","minimum":0,"description":"Room key versions that will be destroyed."},"holds":{"type":"integer","minimum":0,"description":"Holds covering the room (must be 0)."},"openProcedures":{"type":"integer","minimum":0,"description":"Procedures in the room (must be 0)."}},"required":["roomId","retentionUntil","documents","versions","blobs","bytes","keyVersions","holds","openProcedures"],"additionalProperties":false,"description":"Ids-and-counts plan of a room destruction (ADR-0012 D10)."},"planSha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the canonical plan JSON (hex)."},"approvalsRequired":{"type":"integer","minimum":1,"maximum":2,"description":"2 for room destruction (D8.5)."},"requestedBy":{"type":"string","nullable":true,"format":"uuid","description":"Requesting principal."},"requestedAt":{"type":"string","format":"date-time","description":"Request timestamp (UTC)."},"approvedBy":{"type":"string","nullable":true,"format":"uuid","description":"Second approver, or null (cooling-off or pending)."},"approvedAt":{"type":"string","nullable":true,"format":"date-time"},"coolingOffUntil":{"type":"string","nullable":true,"format":"date-time","description":"Set when nobody else was eligible: executes after this unless cancelled (D10)."},"expiresAt":{"type":"string","format":"date-time","description":"Request expiry (D10: 14 days)."},"executedAt":{"type":"string","nullable":true,"format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"deletionRecordId":{"type":"string","nullable":true,"format":"uuid","description":"Deletion record (certificate) once completed."},"failureCode":{"type":"string","nullable":true,"pattern":"^[A-Z][A-Z0-9_]{0,62}$","description":"Why the last execution attempt stopped, as a code."},"callerMayApprove":{"type":"boolean","description":"True when the caller is not the requester and the request awaits approval."}},"required":["id","kind","status","roomId","roomName","reasonCode","plan","planSha256","approvalsRequired","requestedBy","requestedAt","approvedBy","approvedAt","coolingOffUntil","expiresAt","executedAt","completedAt","deletionRecordId","failureCode","callerMayApprove"],"additionalProperties":false,"description":"One deletion request (ADR-0012 D10); no names except the room name while it exists."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no firm_admin/compliance right, a guest or support session, or step-up required: 401 STEP_UP_REQUIRED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, hidden, or cross-tenant: the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Conflict (code LEGAL_HOLD, ROOM_DESTROYING, RETENTION_NOT_EXPIRED, APPROVER_IS_REQUESTER, APPROVER_TENURE, PLAN_CHANGED, REQUEST_NOT_PENDING, REQUEST_EXPIRED); ADR-0012 D11.1 decision order, a hold is always reported first.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/deletion-requests/{requestId}/reject":{"post":{"operationId":"rejectDeletionRequest","summary":"Reject a pending deletion request","description":"`deletion_request.reject` (firm_admin or compliance, step-up). Only a `requested` request (409 REQUEST_NOT_PENDING). Writes `deletion_request.rejected`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Deletion request id."},"required":true,"description":"Deletion request id.","name":"requestId","in":"path"}],"responses":{"200":{"description":"The rejected request.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Deletion request id."},"kind":{"type":"string","enum":["room_destruction"],"description":"Request kind (this slice: room destruction only)."},"status":{"type":"string","enum":["requested","approved","executing","completed","rejected","cancelled","expired","failed"],"description":"Deletion request status (ADR-0012 D10), forward only."},"roomId":{"type":"string","format":"uuid","description":"Room id."},"roomName":{"type":"string","nullable":true,"description":"Room name while the room exists; null once it is destroyed (scrubbed)."},"reasonCode":{"type":"string","enum":["retention_expired","client_instruction","other"],"description":"Why the room is destroyed; the retention end is the normal reason."},"plan":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid","description":"Room id."},"retentionUntil":{"type":"string","format":"date","description":"The expired retention date the plan was made for."},"documents":{"type":"integer","minimum":0,"description":"Documents in the room."},"versions":{"type":"integer","minimum":0,"description":"Document versions in the room."},"blobs":{"type":"integer","minimum":0,"description":"Blobs whose data-key wrap will be destroyed."},"bytes":{"type":"integer","minimum":0,"description":"Plaintext bytes of those blobs."},"keyVersions":{"type":"integer","minimum":0,"description":"Room key versions that will be destroyed."},"holds":{"type":"integer","minimum":0,"description":"Holds covering the room (must be 0)."},"openProcedures":{"type":"integer","minimum":0,"description":"Procedures in the room (must be 0)."}},"required":["roomId","retentionUntil","documents","versions","blobs","bytes","keyVersions","holds","openProcedures"],"additionalProperties":false,"description":"Ids-and-counts plan of a room destruction (ADR-0012 D10)."},"planSha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the canonical plan JSON (hex)."},"approvalsRequired":{"type":"integer","minimum":1,"maximum":2,"description":"2 for room destruction (D8.5)."},"requestedBy":{"type":"string","nullable":true,"format":"uuid","description":"Requesting principal."},"requestedAt":{"type":"string","format":"date-time","description":"Request timestamp (UTC)."},"approvedBy":{"type":"string","nullable":true,"format":"uuid","description":"Second approver, or null (cooling-off or pending)."},"approvedAt":{"type":"string","nullable":true,"format":"date-time"},"coolingOffUntil":{"type":"string","nullable":true,"format":"date-time","description":"Set when nobody else was eligible: executes after this unless cancelled (D10)."},"expiresAt":{"type":"string","format":"date-time","description":"Request expiry (D10: 14 days)."},"executedAt":{"type":"string","nullable":true,"format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"deletionRecordId":{"type":"string","nullable":true,"format":"uuid","description":"Deletion record (certificate) once completed."},"failureCode":{"type":"string","nullable":true,"pattern":"^[A-Z][A-Z0-9_]{0,62}$","description":"Why the last execution attempt stopped, as a code."},"callerMayApprove":{"type":"boolean","description":"True when the caller is not the requester and the request awaits approval."}},"required":["id","kind","status","roomId","roomName","reasonCode","plan","planSha256","approvalsRequired","requestedBy","requestedAt","approvedBy","approvedAt","coolingOffUntil","expiresAt","executedAt","completedAt","deletionRecordId","failureCode","callerMayApprove"],"additionalProperties":false,"description":"One deletion request (ADR-0012 D10); no names except the room name while it exists."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no firm_admin/compliance right, a guest or support session, or step-up required: 401 STEP_UP_REQUIRED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, hidden, or cross-tenant: the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Conflict (code REQUEST_NOT_PENDING); ADR-0012 D11.1 decision order, a hold is always reported first.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/deletion-requests/{requestId}/cancel":{"post":{"operationId":"cancelDeletionRequest","summary":"Cancel a deletion request before it executes","description":"`deletion_request.cancel` (firm_admin or compliance). A `requested` or `approved` request (including one in cooling-off) is cancelled; an executing or finished one is refused with 409 REQUEST_NOT_PENDING. Writes `deletion_request.cancelled`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Deletion request id."},"required":true,"description":"Deletion request id.","name":"requestId","in":"path"}],"responses":{"200":{"description":"The cancelled request.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Deletion request id."},"kind":{"type":"string","enum":["room_destruction"],"description":"Request kind (this slice: room destruction only)."},"status":{"type":"string","enum":["requested","approved","executing","completed","rejected","cancelled","expired","failed"],"description":"Deletion request status (ADR-0012 D10), forward only."},"roomId":{"type":"string","format":"uuid","description":"Room id."},"roomName":{"type":"string","nullable":true,"description":"Room name while the room exists; null once it is destroyed (scrubbed)."},"reasonCode":{"type":"string","enum":["retention_expired","client_instruction","other"],"description":"Why the room is destroyed; the retention end is the normal reason."},"plan":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid","description":"Room id."},"retentionUntil":{"type":"string","format":"date","description":"The expired retention date the plan was made for."},"documents":{"type":"integer","minimum":0,"description":"Documents in the room."},"versions":{"type":"integer","minimum":0,"description":"Document versions in the room."},"blobs":{"type":"integer","minimum":0,"description":"Blobs whose data-key wrap will be destroyed."},"bytes":{"type":"integer","minimum":0,"description":"Plaintext bytes of those blobs."},"keyVersions":{"type":"integer","minimum":0,"description":"Room key versions that will be destroyed."},"holds":{"type":"integer","minimum":0,"description":"Holds covering the room (must be 0)."},"openProcedures":{"type":"integer","minimum":0,"description":"Procedures in the room (must be 0)."}},"required":["roomId","retentionUntil","documents","versions","blobs","bytes","keyVersions","holds","openProcedures"],"additionalProperties":false,"description":"Ids-and-counts plan of a room destruction (ADR-0012 D10)."},"planSha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the canonical plan JSON (hex)."},"approvalsRequired":{"type":"integer","minimum":1,"maximum":2,"description":"2 for room destruction (D8.5)."},"requestedBy":{"type":"string","nullable":true,"format":"uuid","description":"Requesting principal."},"requestedAt":{"type":"string","format":"date-time","description":"Request timestamp (UTC)."},"approvedBy":{"type":"string","nullable":true,"format":"uuid","description":"Second approver, or null (cooling-off or pending)."},"approvedAt":{"type":"string","nullable":true,"format":"date-time"},"coolingOffUntil":{"type":"string","nullable":true,"format":"date-time","description":"Set when nobody else was eligible: executes after this unless cancelled (D10)."},"expiresAt":{"type":"string","format":"date-time","description":"Request expiry (D10: 14 days)."},"executedAt":{"type":"string","nullable":true,"format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"deletionRecordId":{"type":"string","nullable":true,"format":"uuid","description":"Deletion record (certificate) once completed."},"failureCode":{"type":"string","nullable":true,"pattern":"^[A-Z][A-Z0-9_]{0,62}$","description":"Why the last execution attempt stopped, as a code."},"callerMayApprove":{"type":"boolean","description":"True when the caller is not the requester and the request awaits approval."}},"required":["id","kind","status","roomId","roomName","reasonCode","plan","planSha256","approvalsRequired","requestedBy","requestedAt","approvedBy","approvedAt","coolingOffUntil","expiresAt","executedAt","completedAt","deletionRecordId","failureCode","callerMayApprove"],"additionalProperties":false,"description":"One deletion request (ADR-0012 D10); no names except the room name while it exists."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no firm_admin/compliance right, a guest or support session, or step-up required: 401 STEP_UP_REQUIRED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, hidden, or cross-tenant: the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Conflict (code REQUEST_NOT_PENDING); ADR-0012 D11.1 decision order, a hold is always reported first.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/deletion-certificates":{"get":{"operationId":"listDeletionCertificates","summary":"List deletion records and certificates","description":"Every deletion record of the tenant, newest first, with its certificate hash once completed (ADR-0012 D13, RET-04). `retention.overview.read`: firm_admin and compliance.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"Deletion records.","content":{"application/json":{"schema":{"type":"object","properties":{"certificates":{"type":"array","items":{"type":"object","properties":{"recordId":{"type":"string","format":"uuid"},"roomId":{"type":"string","nullable":true,"format":"uuid","description":"Room id."},"requestId":{"type":"string","nullable":true,"format":"uuid"},"kind":{"type":"string","enum":["room_destroyed","document_hard_deleted"],"description":"A destroyed room, or a document deleted definitively from the trash (ADR-0039)."},"status":{"type":"string","enum":["in_progress","completed"]},"startedAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"unreadableAt":{"type":"string","nullable":true,"format":"date-time"},"blobsDestroyed":{"type":"integer","minimum":0},"keyVersionsDestroyed":{"type":"integer","minimum":0},"sha256":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"Certificate hash once completed."}},"required":["recordId","roomId","requestId","kind","status","startedAt","completedAt","unreadableAt","blobsDestroyed","keyVersionsDestroyed","sha256"],"additionalProperties":false,"description":"One deletion record in the certificate list."},"description":"Newest first."}},"required":["certificates"],"description":"Deletion records of the tenant (ADR-0012 D13)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no firm_admin/compliance right, a guest or support session, or step-up required: 401 STEP_UP_REQUIRED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, hidden, or cross-tenant: the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/deletion-certificates/{recordId}":{"get":{"operationId":"getDeletionCertificate","summary":"Download a deletion certificate (JSON)","description":"The certificate of a completed deletion record: what was destroyed (counts, ids, sizes, SHA-256 hashes), how (crypto-shredding) and when (removed, unreadable, irreversible after the 35-day backup horizon), with `sha256` over its canonical JSON; the `deletion.completed` audit event carries the same hash. `deletion_record.read` (firm_admin, compliance); writes `deletion_certificate.downloaded`. 404 while the record is still in progress.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Deletion record id."},"required":true,"description":"Deletion record id.","name":"recordId","in":"path"}],"responses":{"200":{"description":"Certificate with its hash.","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"object","properties":{"format":{"type":"string","enum":["ddr-deletion-certificate/1"]},"recordId":{"type":"string","format":"uuid"},"tenantId":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"roomId":{"type":"string","nullable":true,"format":"uuid","description":"Room id."},"kind":{"type":"string","enum":["room_destroyed","document_hard_deleted"],"description":"A destroyed room (ADR-0035) or a document deleted definitively from the trash (ADR-0039)."},"basis":{"type":"string","enum":["room_destruction","manual_purge","trash_expired"],"description":"Room destruction, the definitive deletion by a room manager, or the automatic purge after the trash period."},"method":{"type":"string","enum":["crypto_shredding"],"description":"Room: every room key version and data-key wrap destroyed. Document: the data-key wrap of every blob no other reference holds destroyed (ADR-0004 D8)."},"requestId":{"type":"string","nullable":true,"format":"uuid"},"reasonCode":{"type":"string","nullable":true},"requestedBy":{"type":"string","nullable":true,"format":"uuid"},"approvedBy":{"type":"string","nullable":true,"format":"uuid"},"coolingOff":{"type":"boolean"},"counts":{"type":"object","properties":{"documents":{"type":"integer","minimum":0},"versions":{"type":"integer","minimum":0},"blobsDestroyed":{"type":"integer","minimum":0},"blobsRetained":{"type":"integer","minimum":0},"bytesDestroyed":{"type":"integer","minimum":0},"keyVersionsDestroyed":{"type":"integer","minimum":0}},"required":["documents","versions","blobsDestroyed","blobsRetained","bytesDestroyed","keyVersionsDestroyed"],"additionalProperties":false},"dates":{"type":"object","properties":{"startedAt":{"type":"string","format":"date-time"},"metadataDeletedAt":{"type":"string","format":"date-time","description":"Removed from the application."},"unreadableAt":{"type":"string","format":"date-time","description":"Unreadable in the live system (last key or text step)."},"irreversibleAt":{"type":"string","format":"date-time","description":"Irreversible in every backup: unreadableAt + 35 days."},"primaryCiphertextRemovedBy":{"type":"string","format":"date-time","description":"Ciphertext removed at the primary no later than (delete marker + 30 days)."},"offsiteRemovedBy":{"type":"string","format":"date-time","description":"Offsite copies removed no later than (+36 days)."},"tombstonesConfirmedAt":{"type":"string","nullable":true,"format":"date-time","description":"Offsite tombstones confirmed, or null where offsite replication is not enabled."},"completedAt":{"type":"string","format":"date-time"}},"required":["startedAt","metadataDeletedAt","unreadableAt","irreversibleAt","primaryCiphertextRemovedBy","offsiteRemovedBy","tombstonesConfirmedAt","completedAt"],"additionalProperties":false},"backupHorizonDays":{"type":"number","enum":[35]},"statements":{"type":"array","items":{"type":"string","enum":["room_keys_destroyed","data_key_wraps_destroyed","plaintext_rows_scrubbed","objects_delete_marked","audit_trail_retained","irreversible_after_backup_horizon","offsite_tombstones_pending","content_retained_under_other_reference"]},"description":"Statement codes the PDF renders in NL and EN."},"items":{"type":"array","items":{"type":"object","properties":{"objectType":{"type":"string","enum":["document","document_version","blob","derivative","room_key"]},"objectId":{"type":"string","format":"uuid"},"sizePlain":{"type":"integer","nullable":true,"minimum":0,"description":"Plaintext size in bytes (blobs)."},"sha256Plain":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"Plaintext SHA-256 (blobs), as on receipts (ADR-0006 D3.5)."},"contentState":{"type":"string","nullable":true,"enum":["destroyed","retained_referenced",null]},"contentDestroyedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["objectType","objectId","sizePlain","sha256Plain","contentState","contentDestroyedAt"],"additionalProperties":false,"description":"One object of a deletion record (ADR-0012 D13)."}}},"required":["format","recordId","tenantId","roomId","kind","basis","method","requestId","reasonCode","requestedBy","approvedBy","coolingOff","counts","dates","backupHorizonDays","statements","items"],"additionalProperties":false,"description":"Deletion certificate body; ids, counts, sizes, hashes and dates only (RET-04)."},"sha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"SHA-256 (hex) of the canonical JSON of `certificate` (keys sorted, no whitespace, UTF-8); the `deletion.completed` audit event carries the same hash."}},"required":["certificate","sha256"],"additionalProperties":false,"description":"A deletion certificate with its verification hash (ADR-0012 D13)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no firm_admin/compliance right, a guest or support session, or step-up required: 401 STEP_UP_REQUIRED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, hidden, or cross-tenant: the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/deletion-certificates/{recordId}/pdf":{"get":{"operationId":"getDeletionCertificatePdf","summary":"Download a deletion certificate (PDF)","description":"The same certificate rendered as a bilingual (NL/EN) PDF that prints the certificate SHA-256, so a reader can check it against the JSON and the audit trail. `deletion_record.read`; writes `deletion_certificate.downloaded`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Deletion record id."},"required":true,"description":"Deletion record id.","name":"recordId","in":"path"}],"responses":{"200":{"description":"Certificate PDF.","content":{"application/pdf":{"schema":{"type":"string","description":"Certificate PDF bytes."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no firm_admin/compliance right, a guest or support session, or step-up required: 401 STEP_UP_REQUIRED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown id, hidden, or cross-tenant: the same 404).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/billing/overview":{"get":{"operationId":"getBillingOverview","summary":"Read the plan, seats, price and storage usage of the firm","description":"The firm plan (tenant setting), the billable members (every active office member counts once, whatever their roles or email domain; guests free), the PLAN §7.3 graduated annual price per bracket with monthly and yearly totals excl. and incl. 21 % VAT, the organisation storage pool against the plan allowance with the largest rooms, and an always empty invoice list (payments are not active). Firm admin and compliance only (`billing.overview.read`).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"Plan and usage.","content":{"application/json":{"schema":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid"},"plan":{"type":"string","enum":["flex","basis","pro","enterprise"],"description":"Subscription plan (PLAN §7.3): flex, basis, pro or enterprise."},"seats":{"type":"object","properties":{"professionals":{"type":"integer","minimum":0,"maximum":100000,"description":"Billable seats: every active office member counts once, whatever their roles or email domain."},"supportUsers":{"type":"integer","minimum":0,"maximum":100000,"description":"Informative sub-count: active members holding only support roles (secretary, back office). Already included in professionals; never priced separately."},"guests":{"type":"integer","minimum":0,"maximum":100000,"description":"Active guests: free and unlimited, never billed."},"byRole":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["firm_admin","lawyer","legal_assistant","secretary","billing","adviser","back_office","compliance"],"description":"Firm role (ADR-0005 §3)."},"users":{"type":"integer","minimum":0,"maximum":100000,"description":"Active firm users holding this role (a user may hold several)."}},"required":["role","users"],"description":"Active firm users per role."}}},"required":["professionals","supportUsers","guests","byRole"],"description":"Seats counted from the active firm users; guests are listed but free."},"activeFiles":{"type":"integer","minimum":0,"maximum":100000,"description":"Active rooms (the Flex unit)."},"quote":{"type":"object","properties":{"plan":{"type":"string","enum":["flex","basis","pro","enterprise"],"description":"Subscription plan (PLAN §7.3): flex, basis, pro or enterprise."},"professionals":{"type":"integer","minimum":0,"maximum":100000,"description":"Billable members: every active office member counts once."},"activeFiles":{"type":"integer","minimum":0,"maximum":100000,"description":"Active files (rooms); only priced on Flex."},"tiers":{"type":"array","items":{"type":"object","properties":{"from":{"type":"integer","minimum":1,"description":"First member of the bracket."},"to":{"type":"integer","nullable":true,"minimum":1,"description":"Last member of the bracket; null = and up."},"professionals":{"type":"integer","minimum":0,"maximum":100000,"description":"Members billed in this bracket."},"unitAnnualCents":{"type":"integer","minimum":0,"description":"Price per member per year in this bracket (excl. VAT)."},"annualCents":{"type":"integer","minimum":0,"description":"professionals x unitAnnualCents."},"monthlyCents":{"type":"integer","minimum":0,"description":"Monthly share of this line (annualCents / 12, rounded)."}},"required":["from","to","professionals","unitAnnualCents","annualCents","monthlyCents"],"description":"One graduated price bracket (PLAN §7.3, approved 9 October 2026)."},"description":"Graduated brackets with at least one member."},"extras":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["support_users","enterprise_pack","flex_files"],"description":"Extra line: the Enterprise pack or Flex files (support_users is kept for wire compat)."},"quantity":{"type":"integer","minimum":0,"maximum":100000},"unitCents":{"type":"integer","minimum":0,"description":"Unit price excl. VAT (per year or per file, see `unit`)."},"unit":{"type":"string","enum":["month","year","file"],"description":"What the unit price is charged per."},"monthlyCents":{"type":"integer","minimum":0,"description":"Monthly equivalent excl. VAT (a yearly or one-off amount / 12, rounded)."},"annualCents":{"type":"integer","minimum":0,"description":"Yearly amount excl. VAT."}},"required":["code","quantity","unitCents","unit","monthlyCents","annualCents"],"description":"A price line outside the member brackets (PLAN §7.3)."}},"monthly":{"type":"object","properties":{"exclVatCents":{"type":"integer","minimum":0},"vatCents":{"type":"integer","minimum":0},"inclVatCents":{"type":"integer","minimum":0}},"required":["exclVatCents","vatCents","inclVatCents"],"description":"Per month, billed annually."},"annual":{"type":"object","properties":{"exclVatCents":{"type":"integer","minimum":0},"vatCents":{"type":"integer","minimum":0},"inclVatCents":{"type":"integer","minimum":0}},"required":["exclVatCents","vatCents","inclVatCents"],"description":"Per year (exact graduated total with annual billing)."},"monthlyBilling":{"type":"object","properties":{"exclVatCents":{"type":"integer","minimum":0},"vatCents":{"type":"integer","minimum":0},"inclVatCents":{"type":"integer","minimum":0}},"required":["exclVatCents","vatCents","inclVatCents"],"description":"Per month when billed monthly (annual seat amount / 12 x 19/15)."},"averagePerProfessionalCents":{"type":"integer","nullable":true,"minimum":0,"description":"Brackets only: average price per member per month; null without members."},"includedStorageBytes":{"type":"integer","minimum":0,"description":"Storage the plan adds to the organisation pool (decimal bytes)."}},"required":["plan","professionals","activeFiles","tiers","extras","monthly","annual","monthlyBilling","averagePerProfessionalCents","includedStorageBytes"],"description":"The current price, computed from the seats above."},"storage":{"type":"object","properties":{"poolBytes":{"type":"integer","nullable":true,"minimum":0,"description":"Configured organisation pool (storage pool row); null before the first upload."},"includedBytes":{"type":"integer","minimum":0,"description":"Pool size the plan includes for these seats."},"usedHotBytes":{"type":"integer","minimum":0},"usedArchiveBytes":{"type":"integer","minimum":0},"reservedBytes":{"type":"integer","minimum":0},"state":{"type":"string","nullable":true,"enum":["ok","warning","grace","blocked",null],"description":"Derived pool state (ADR-0007 D10): ok, warning at 80 %, grace, or blocked."},"roomCount":{"type":"integer","minimum":0,"maximum":100000,"description":"Rooms that store at least one byte."},"largestRooms":{"type":"array","items":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true,"description":"Firm-visible room name. Never a document or file name, never content."},"bytes":{"type":"integer","minimum":0,"description":"Stored originals incl. all versions (plaintext bytes)."}},"required":["roomId","name","bytes"],"description":"Storage of one room (DOC-23)."},"maxItems":8}},"required":["poolBytes","includedBytes","usedHotBytes","usedArchiveBytes","reservedBytes","state","roomCount","largestRooms"],"description":"The organisation storage pool (BILL-05): one pool, no limit per user, room or file."},"invoices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"]},"maxItems":0,"description":"Always empty until payments are active (Mollie, BILL-03, deferred)."},"paymentsActive":{"type":"boolean","enum":[false],"description":"No payment provider is connected yet."},"generatedAt":{"type":"string","format":"date-time"}},"required":["tenantId","plan","seats","activeFiles","quote","storage","invoices","paymentsActive","generatedAt"],"description":"Beheer > Abonnement en gebruik: plan, seats, price and storage (BILL-01/05/07)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: not a firm admin or compliance officer (guests and support never).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/billing/quote":{"get":{"operationId":"getBillingQuote","summary":"What would it cost: a PLAN §7.3 price quote for a seat count","description":"The calculator of the Plan and usage page: the graduated annual bracket price for a plan and a number of members and (Flex) active files, excl. and incl. 21 % VAT, per month and per year. Computed by the server; reads no firm data. Firm admin and compliance only (`billing.overview.read`). 400 on an unknown plan or a count outside 0..100000.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","enum":["flex","basis","pro","enterprise"],"default":"pro","description":"Subscription plan (PLAN §7.3): flex, basis, pro or enterprise."},"required":false,"description":"Subscription plan (PLAN §7.3): flex, basis, pro or enterprise.","name":"plan","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"maximum":100000},"required":false,"name":"professionals","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"maximum":100000,"default":0},"required":false,"name":"activeFiles","in":"query"}],"responses":{"200":{"description":"The quote.","content":{"application/json":{"schema":{"type":"object","properties":{"plan":{"type":"string","enum":["flex","basis","pro","enterprise"],"description":"Subscription plan (PLAN §7.3): flex, basis, pro or enterprise."},"professionals":{"type":"integer","minimum":0,"maximum":100000,"description":"Billable members: every active office member counts once."},"activeFiles":{"type":"integer","minimum":0,"maximum":100000,"description":"Active files (rooms); only priced on Flex."},"tiers":{"type":"array","items":{"type":"object","properties":{"from":{"type":"integer","minimum":1,"description":"First member of the bracket."},"to":{"type":"integer","nullable":true,"minimum":1,"description":"Last member of the bracket; null = and up."},"professionals":{"type":"integer","minimum":0,"maximum":100000,"description":"Members billed in this bracket."},"unitAnnualCents":{"type":"integer","minimum":0,"description":"Price per member per year in this bracket (excl. VAT)."},"annualCents":{"type":"integer","minimum":0,"description":"professionals x unitAnnualCents."},"monthlyCents":{"type":"integer","minimum":0,"description":"Monthly share of this line (annualCents / 12, rounded)."}},"required":["from","to","professionals","unitAnnualCents","annualCents","monthlyCents"],"description":"One graduated price bracket (PLAN §7.3, approved 9 October 2026)."},"description":"Graduated brackets with at least one member."},"extras":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["support_users","enterprise_pack","flex_files"],"description":"Extra line: the Enterprise pack or Flex files (support_users is kept for wire compat)."},"quantity":{"type":"integer","minimum":0,"maximum":100000},"unitCents":{"type":"integer","minimum":0,"description":"Unit price excl. VAT (per year or per file, see `unit`)."},"unit":{"type":"string","enum":["month","year","file"],"description":"What the unit price is charged per."},"monthlyCents":{"type":"integer","minimum":0,"description":"Monthly equivalent excl. VAT (a yearly or one-off amount / 12, rounded)."},"annualCents":{"type":"integer","minimum":0,"description":"Yearly amount excl. VAT."}},"required":["code","quantity","unitCents","unit","monthlyCents","annualCents"],"description":"A price line outside the member brackets (PLAN §7.3)."}},"monthly":{"type":"object","properties":{"exclVatCents":{"type":"integer","minimum":0},"vatCents":{"type":"integer","minimum":0},"inclVatCents":{"type":"integer","minimum":0}},"required":["exclVatCents","vatCents","inclVatCents"],"description":"Per month, billed annually."},"annual":{"type":"object","properties":{"exclVatCents":{"type":"integer","minimum":0},"vatCents":{"type":"integer","minimum":0},"inclVatCents":{"type":"integer","minimum":0}},"required":["exclVatCents","vatCents","inclVatCents"],"description":"Per year (exact graduated total with annual billing)."},"monthlyBilling":{"type":"object","properties":{"exclVatCents":{"type":"integer","minimum":0},"vatCents":{"type":"integer","minimum":0},"inclVatCents":{"type":"integer","minimum":0}},"required":["exclVatCents","vatCents","inclVatCents"],"description":"Per month when billed monthly (annual seat amount / 12 x 19/15)."},"averagePerProfessionalCents":{"type":"integer","nullable":true,"minimum":0,"description":"Brackets only: average price per member per month; null without members."},"includedStorageBytes":{"type":"integer","minimum":0,"description":"Storage the plan adds to the organisation pool (decimal bytes)."}},"required":["plan","professionals","activeFiles","tiers","extras","monthly","annual","monthlyBilling","averagePerProfessionalCents","includedStorageBytes"],"description":"A price quote under PLAN §7.3 (excl. VAT unless stated), computed by the server."}}}},"400":{"description":"Invalid plan or count.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: not a firm admin or compliance officer (guests and support never).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/billing/storage-pool":{"get":{"operationId":"getStoragePoolMetering","summary":"Read the organisation storage pool metering","description":"The organisation storage pool meter (size, hot/archive usage, reservation, remaining, state and grace end) for the enterprise storage alerts UI. One pool per tenant; ids and counts only. Firm admin and compliance only (`billing.overview.read`). 404 before the first upload (including cross-tenant).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"Pool metering.","content":{"application/json":{"schema":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"poolBytes":{"type":"integer","minimum":0,"description":"Configured organisation pool in plaintext bytes."},"usedHotBytes":{"type":"integer","minimum":0,"description":"Billable hot bytes (plaintext)."},"usedArchiveBytes":{"type":"integer","minimum":0,"description":"Billable archive bytes (plaintext)."},"reservedBytes":{"type":"integer","minimum":0,"description":"Open upload reservations; counted towards the limit."},"usageBytes":{"type":"integer","minimum":0,"description":"usedHotBytes + reservedBytes: the usage compared against poolBytes."},"remainingBytes":{"type":"integer","description":"poolBytes - usageBytes; negative during the grace period."},"state":{"type":"string","enum":["ok","warning","grace","blocked"],"description":"Derived pool state (ADR-0007 D10): ok, warning at 80 %, grace, or blocked."},"graceEndsAt":{"type":"string","nullable":true,"format":"date-time","description":"When the grace period ends (overLimitSince + 30 days), or null outside grace/blocked."},"generatedAt":{"type":"string","format":"date-time","description":"When this metering read was generated."}},"required":["tenantId","poolBytes","usedHotBytes","usedArchiveBytes","reservedBytes","usageBytes","remainingBytes","state","graceEndsAt","generatedAt"],"description":"Organisation storage pool metering (BILL-05): one meter per tenant."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: not a firm admin or compliance officer (guests and support never).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/download":{"get":{"operationId":"downloadDocument","summary":"Download a document (original or watermarked PDF)","description":"Requires `document.download` (read level `download`) on the document node. `format=original` streams the decrypted original of the version (chunked, verified against the stored plaintext hash); `format=pdf` returns a PDF with a per-page watermark (name, e-mail, time and a forensic id) built from the worker-rendered pages. A PDF-only caller (group setting \"PDF only\" or the firm guest setting, see `sourceAccess`) gets `pdf` by default, named `{stem}.pdf`, and 403 `DOWNLOAD_MODE_RESTRICTED` for `original`. Writes `document.downloaded` (version id, variant, forensic id) before the first byte; rate limited per principal. A caller without `node.read` gets 404 (PERM-02); a caller who can see but not download gets 403.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"},{"schema":{"type":"string","pattern":"^[1-9][0-9]{0,8}$","description":"1-based version number; default the current version."},"required":false,"description":"1-based version number; default the current version.","name":"version","in":"query"},{"schema":{"type":"string","enum":["original","pdf"],"description":"Default: `original`, or `pdf` when the caller may only download watermarked PDFs."},"required":false,"description":"Default: `original`, or `pdf` when the caller may only download watermarked PDFs.","name":"format","in":"query"}],"responses":{"200":{"description":"The file.","headers":{"Content-Disposition":{"schema":{"type":"string","description":"`attachment` (download) or `inline` (print) with a sanitised file name."},"required":true,"description":"`attachment` (download) or `inline` (print) with a sanitised file name."},"Cache-Control":{"schema":{"type":"string","enum":["no-store"],"description":"Never cached."},"required":true,"description":"Never cached."}},"content":{"application/octet-stream":{"schema":{"type":"string","description":"The original file bytes."}},"application/pdf":{"schema":{"type":"string","description":"The watermarked PDF."}}}},"202":{"description":"The watermarked PDF needs pages that are still being rendered (`PAGE_RENDERING`); retry after Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"400":{"description":"Invalid query.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out, or stronger authentication is required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"The caller can see the document but may not download it, or only watermarked PDFs are allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"The version is archived (`SOURCE_UNAVAILABLE`) or has no PDF rendition (`PDF_UNAVAILABLE`).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Too many downloads for this principal; see Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"The audit event could not be written; nothing was served.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/print":{"get":{"operationId":"printDocument","summary":"Print a document (watermarked PDF)","description":"Requires `document.print` (read level `print` or `download`) on the document node. Returns an inline print-optimised PDF (A4 pages, per-page watermark with name, e-mail, time and a forensic id) built from the worker-rendered pages. Writes `document.printed` before the first byte; rate limited per principal. 404 hides a document the caller cannot see; 403 when it can only view.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"},{"schema":{"type":"string","pattern":"^[1-9][0-9]{0,8}$","description":"1-based version number; default the current version."},"required":false,"description":"1-based version number; default the current version.","name":"version","in":"query"}],"responses":{"200":{"description":"The print PDF.","headers":{"Content-Disposition":{"schema":{"type":"string","description":"`attachment` (download) or `inline` (print) with a sanitised file name."},"required":true,"description":"`attachment` (download) or `inline` (print) with a sanitised file name."},"Cache-Control":{"schema":{"type":"string","enum":["no-store"],"description":"Never cached."},"required":true,"description":"Never cached."}},"content":{"application/pdf":{"schema":{"type":"string","description":"The watermarked PDF."}}}},"202":{"description":"Pages are still being rendered (`PAGE_RENDERING`).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"400":{"description":"Invalid query.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out, or stronger authentication is required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"The caller may only view the document.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Archived, or no PDF rendition.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Too many downloads for this principal; see Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"The audit event could not be written; nothing was served.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/download-jobs":{"post":{"operationId":"createDownloadJob","summary":"Start a bulk download (ZIP) of selected documents and folders","description":"Every selected node needs `node.read` (else 404, PERM-02). Folders are expanded; each visible document goes in when the caller holds `document.download` on it and it is available, else it is listed by name in the README of the ZIP. Documents the caller cannot see are left out silently. The worker builds one ZIP with the folder structure and index numbers, encrypted in the exports bucket for 7 days, and notifies the caller when it is ready. 403 `NOTHING_TO_DOWNLOAD` when no selected document may be downloaded; 413 `SELECTION_TOO_LARGE` above 500 documents or 512 MiB. Writes `export.created`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"nodeIds":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"maxItems":200,"description":"Selected documents and folders of the room index (folders are expanded)."},"format":{"type":"string","enum":["original","pdf"],"description":"Default: `original`, or `pdf` when the caller may only download watermarked PDFs."}},"required":["nodeIds"],"additionalProperties":false,"description":"Create a bulk download (ZIP) of a selection."}}}},"responses":{"202":{"description":"Queued.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Download job id."},"roomId":{"type":"string","format":"uuid","description":"Room of the selection."},"status":{"type":"string","enum":["queued","building","ready","failed","expired"],"description":"Build state of a bulk download."},"format":{"type":"string","enum":["original","pdf","archive"],"description":"What the ZIP holds: original files, watermarked PDFs, or the full room archive."},"documentCount":{"type":"integer","minimum":0,"description":"Documents that go into the ZIP."},"skippedCount":{"type":"integer","minimum":0,"description":"Visible documents left out (no download right or not available); listed in the README."},"progress":{"type":"object","properties":{"done":{"type":"integer","minimum":0,"description":"Documents written so far."},"total":{"type":"integer","minimum":0,"description":"Documents to write."}},"required":["done","total"],"description":"Build progress."},"sizeBytes":{"type":"integer","nullable":true,"minimum":0,"description":"ZIP size once built."},"failureCode":{"type":"string","nullable":true,"pattern":"^[A-Z][A-Z0-9_]{0,62}$","description":"Why the build failed; null otherwise."},"createdAt":{"type":"string","format":"date-time","description":"When the job was created."},"completedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the build finished."},"expiresAt":{"type":"string","format":"date-time","description":"When the ZIP stops being downloadable."}},"required":["id","roomId","status","format","documentCount","skippedCount","progress","sizeBytes","failureCode","createdAt","completedAt","expiresAt"],"description":"A bulk download job (ids, counts and codes only)."}}}},"400":{"description":"Invalid body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out, or stronger authentication is required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Nothing in the selection may be downloaded, or only watermarked PDFs are allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or an invisible node).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"413":{"description":"The selection is too large.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Too many downloads for this principal; see Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/download-jobs/{jobId}":{"get":{"operationId":"getDownloadJob","summary":"Read the progress of a bulk download","description":"Only the creator of the job; anyone else (and another tenant) gets 404. Ids, counts and codes only.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Download job id."},"required":true,"description":"Download job id.","name":"jobId","in":"path"}],"responses":{"200":{"description":"The job.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Download job id."},"roomId":{"type":"string","format":"uuid","description":"Room of the selection."},"status":{"type":"string","enum":["queued","building","ready","failed","expired"],"description":"Build state of a bulk download."},"format":{"type":"string","enum":["original","pdf","archive"],"description":"What the ZIP holds: original files, watermarked PDFs, or the full room archive."},"documentCount":{"type":"integer","minimum":0,"description":"Documents that go into the ZIP."},"skippedCount":{"type":"integer","minimum":0,"description":"Visible documents left out (no download right or not available); listed in the README."},"progress":{"type":"object","properties":{"done":{"type":"integer","minimum":0,"description":"Documents written so far."},"total":{"type":"integer","minimum":0,"description":"Documents to write."}},"required":["done","total"],"description":"Build progress."},"sizeBytes":{"type":"integer","nullable":true,"minimum":0,"description":"ZIP size once built."},"failureCode":{"type":"string","nullable":true,"pattern":"^[A-Z][A-Z0-9_]{0,62}$","description":"Why the build failed; null otherwise."},"createdAt":{"type":"string","format":"date-time","description":"When the job was created."},"completedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the build finished."},"expiresAt":{"type":"string","format":"date-time","description":"When the ZIP stops being downloadable."}},"required":["id","roomId","status","format","documentCount","skippedCount","progress","sizeBytes","failureCode","createdAt","completedAt","expiresAt"],"description":"A bulk download job (ids, counts and codes only)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or another principal).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/download-jobs/{jobId}/download":{"get":{"operationId":"downloadDownloadJob","summary":"Download a built bulk download (ZIP)","description":"Only the creator. Re-checks `document.download` on every document in the job manifest with current rights (403 when one is no longer allowed), streams the decrypted ZIP verified against its recorded hash, and writes `export.downloaded` plus one `document.downloaded` per included document before the first byte. 409 `DOWNLOAD_NOT_READY` while building, 410 `DOWNLOAD_EXPIRED` after 7 days; rate limited per principal.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Download job id."},"required":true,"description":"Download job id.","name":"jobId","in":"path"}],"responses":{"200":{"description":"The ZIP.","headers":{"Content-Disposition":{"schema":{"type":"string","description":"`attachment` (download) or `inline` (print) with a sanitised file name."},"required":true,"description":"`attachment` (download) or `inline` (print) with a sanitised file name."},"Cache-Control":{"schema":{"type":"string","enum":["no-store"],"description":"Never cached."},"required":true,"description":"Never cached."}},"content":{"application/zip":{"schema":{"type":"string","description":"The ZIP bytes."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"A document in the ZIP may no longer be downloaded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or another principal).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Not built yet, or the build failed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"410":{"description":"Expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Too many downloads for this principal; see Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"The audit event could not be written; nothing was served.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/qa/exports":{"post":{"operationId":"createRoomQaExport","summary":"Export the Q&A log as XLSX or PDF","description":"qa.read on the room. Exports what the caller may read: every bidder group for internal readers; for a bidder only its own group plus the published FAQ (anonymised: no group, number or document link). Columns: number, group, category, priority, status, asked/due/published dates, linked document (index number and title, only when the caller may read it) and page, subject, question and the published answer. A worker builds the file, encrypted in the exports bucket for 7 days. Writes `export.created` (export kind `qa_log`) when built; rate limited per principal.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"format":{"type":"string","enum":["xlsx","pdf"],"description":"xlsx = overview spreadsheet; pdf = detailed log with the question and answer texts."},"locale":{"type":"string","enum":["nl","en"],"description":"Language of labels and headings."}},"required":["format","locale"],"additionalProperties":false,"description":"Export the Q&A log as the caller may read it."}}}},"responses":{"202":{"description":"Queued.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Export id."},"roomId":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["queued","building","ready","failed","expired"],"description":"Build state of a Q&A export."},"format":{"type":"string","enum":["xlsx","pdf"],"description":"xlsx = overview spreadsheet; pdf = detailed log with the question and answer texts."},"questionCount":{"type":"integer","minimum":0,"description":"Questions in the export."},"sizeBytes":{"type":"integer","nullable":true,"minimum":0,"description":"File size once built."},"failureCode":{"type":"string","nullable":true,"pattern":"^[A-Z][A-Z0-9_]{0,62}$","description":"Why the build failed; null otherwise."},"createdAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","format":"date-time","description":"When the file stops being downloadable."}},"required":["id","roomId","status","format","questionCount","sizeBytes","failureCode","createdAt","completedAt","expiresAt"],"additionalProperties":false,"description":"A Q&A log export (ids, counts and codes only)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, Q&A not enabled, no access, or an export of another principal (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Too many requests; see Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"The export queue is unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/qa/exports/{exportId}":{"get":{"operationId":"getRoomQaExport","summary":"Read the state of a Q&A export","description":"Only the requester, while it may still read the room’s Q&A; anyone else gets 404.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Export id."},"required":true,"description":"Export id.","name":"exportId","in":"path"}],"responses":{"200":{"description":"The export.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Export id."},"roomId":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["queued","building","ready","failed","expired"],"description":"Build state of a Q&A export."},"format":{"type":"string","enum":["xlsx","pdf"],"description":"xlsx = overview spreadsheet; pdf = detailed log with the question and answer texts."},"questionCount":{"type":"integer","minimum":0,"description":"Questions in the export."},"sizeBytes":{"type":"integer","nullable":true,"minimum":0,"description":"File size once built."},"failureCode":{"type":"string","nullable":true,"pattern":"^[A-Z][A-Z0-9_]{0,62}$","description":"Why the build failed; null otherwise."},"createdAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","format":"date-time","description":"When the file stops being downloadable."}},"required":["id","roomId","status","format","questionCount","sizeBytes","failureCode","createdAt","completedAt","expiresAt"],"additionalProperties":false,"description":"A Q&A log export (ids, counts and codes only)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, Q&A not enabled, no access, or an export of another principal (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/qa/exports/{exportId}/download":{"get":{"operationId":"downloadRoomQaExport","summary":"Download a built Q&A export","description":"Only the requester, while it may still read the room’s Q&A. Streams the decrypted file verified against its recorded hash and writes `export.downloaded` (export kind `qa_log`) before the first byte. 409 `DOWNLOAD_NOT_READY` while building or after a failure, 410 `DOWNLOAD_EXPIRED` after 7 days; rate limited per principal.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Export id."},"required":true,"description":"Export id.","name":"exportId","in":"path"}],"responses":{"200":{"description":"The file.","headers":{"Content-Disposition":{"schema":{"type":"string","description":"`attachment` with a file name made of the date only."},"required":true,"description":"`attachment` with a file name made of the date only."},"Cache-Control":{"schema":{"type":"string","enum":["no-store"],"description":"Never cached."},"required":true,"description":"Never cached."}},"content":{"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","description":"The XLSX overview."}},"application/pdf":{"schema":{"type":"string","description":"The detailed PDF."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, Q&A not enabled, no access, or an export of another principal (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Not built yet, or the build failed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"410":{"description":"Expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Too many requests; see Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"The audit event could not be written; nothing was served.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/qa/import/template":{"get":{"operationId":"getRoomQaImportTemplate","summary":"Download the Excel import template","description":"qa.manage on the room. An XLSX with the header row (category, priority, question, document, page) and a second sheet listing the allowed categories and priorities. Holds no room data.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","enum":["nl","en"],"description":"Default nl."},"required":false,"description":"Default nl.","name":"locale","in":"query"}],"responses":{"200":{"description":"The template.","headers":{"Content-Disposition":{"schema":{"type":"string","description":"`attachment` with a file name made of the date only."},"required":true,"description":"`attachment` with a file name made of the date only."},"Cache-Control":{"schema":{"type":"string","enum":["no-store"],"description":"Never cached."},"required":true,"description":"Never cached."}},"content":{"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","description":"The template."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (only a coordinator imports; or the room is not active).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, Q&A not enabled, no access, or an export of another principal (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/qa/import/preview":{"post":{"operationId":"previewRoomQaImport","summary":"Validate an import file without writing","description":"qa.manage on the room. Reads the first sheet of the template and validates each row: category and priority (codes or the NL/EN labels; empty = general / normal), the question (required, at most 10,000 characters), the document by its index number (must exist and be readable by the caller) and the page (needs a document). Rows beyond the group’s remaining quota get `QUOTA_EXCEEDED`. Nothing is written or audited.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"The bidder group the questions are recorded for."},"required":true,"description":"The bidder group the questions are recorded for.","name":"groupId","in":"query"}],"requestBody":{"content":{"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","description":"The filled-in import template (XLSX, at most 2 MiB)."}}}},"responses":{"200":{"description":"Rows with their errors.","content":{"application/json":{"schema":{"type":"object","properties":{"groupId":{"type":"string","format":"uuid"},"groupName":{"type":"string","nullable":true},"rows":{"type":"array","items":{"type":"object","properties":{"row":{"type":"integer","minimum":2,"description":"Row number in the sheet (the header is row 1)."},"category":{"type":"string","nullable":true,"enum":["general","legal","financial","tax","commercial","hr","it","real_estate","environmental","other",null],"description":"Null when the cell holds an unknown category."},"priority":{"type":"string","nullable":true,"enum":["low","normal","high",null],"description":"Null when the cell holds an unknown priority."},"subject":{"type":"string","nullable":true,"description":"Subject derived from the first line of the question."},"body":{"type":"string","nullable":true,"description":"Question text (client data)."},"documentReference":{"type":"string","nullable":true,"description":"Index number as given, e.g. 2.1.3."},"documentTitle":{"type":"string","nullable":true,"description":"Title of the referenced document or folder, when found and readable."},"nodeId":{"type":"string","nullable":true,"format":"uuid"},"pageNo":{"type":"integer","nullable":true,"minimum":1},"errors":{"type":"array","items":{"type":"string","enum":["CATEGORY_INVALID","PRIORITY_INVALID","QUESTION_MISSING","QUESTION_TOO_LONG","DOCUMENT_REFERENCE_INVALID","DOCUMENT_NOT_FOUND","PAGE_INVALID","PAGE_WITHOUT_DOCUMENT","QUOTA_EXCEEDED"],"description":"Why a row cannot be imported."}}},"required":["row","category","priority","subject","body","documentReference","documentTitle","nodeId","pageNo","errors"],"additionalProperties":false,"description":"One validated row of an import file."}},"validCount":{"type":"integer","minimum":0},"errorCount":{"type":"integer","minimum":0,"description":"Rows with at least one error."},"quota":{"type":"object","properties":{"limit":{"type":"integer","nullable":true,"minimum":0,"description":"null = no limit."},"used":{"type":"integer","minimum":0},"remaining":{"type":"integer","nullable":true,"minimum":0}},"required":["limit","used","remaining"],"additionalProperties":false}},"required":["groupId","groupName","rows","validCount","errorCount","quota"],"additionalProperties":false,"description":"Validation result of an import file; nothing is written."}}}},"400":{"description":"`IMPORT_FILE_INVALID` (not a readable XLSX), `IMPORT_TEMPLATE_MISMATCH` (the first row is not the template header), `IMPORT_EMPTY` (no question rows) or an unknown group.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (only a coordinator imports; or the room is not active).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, Q&A not enabled, no access, or an export of another principal (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"413":{"description":"`IMPORT_TOO_LARGE`: over 2 MiB or 500 question rows.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Too many requests; see Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/qa/import":{"post":{"operationId":"importRoomQaQuestions","summary":"Create the questions of an import file for a bidder group","description":"qa.manage on the room. Validates the file again exactly like the preview and creates every question in one transaction, or none: 422 `IMPORT_ROWS_INVALID` while a row has an error, 409 `QUOTA_EXCEEDED` when the quota was used up since the preview. Each question is recorded on behalf of the group (numbered after its existing questions) and audited as `qa_question.asked` with `imported` and one `import_id`; the deal team gets one content-free e-mail.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"The bidder group the questions are recorded for."},"required":true,"description":"The bidder group the questions are recorded for.","name":"groupId","in":"query"}],"requestBody":{"content":{"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","description":"The filled-in import template (XLSX, at most 2 MiB)."}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"type":"object","properties":{"groupId":{"type":"string","format":"uuid"},"importId":{"type":"string","format":"uuid","description":"Shared by the audit events of this import."},"imported":{"type":"integer","minimum":1},"questionIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["groupId","importId","imported","questionIds"],"additionalProperties":false,"description":"The questions created by an import."}}}},"400":{"description":"`IMPORT_FILE_INVALID` (not a readable XLSX), `IMPORT_TEMPLATE_MISMATCH` (the first row is not the template header), `IMPORT_EMPTY` (no question rows) or an unknown group.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (only a coordinator imports; or the room is not active).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, Q&A not enabled, no access, or an export of another principal (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"`QUOTA_EXCEEDED`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"413":{"description":"`IMPORT_TOO_LARGE`: over 2 MiB or 500 question rows.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"422":{"description":"`IMPORT_ROWS_INVALID`: preview the file for the errors.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Too many requests; see Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/trash":{"get":{"operationId":"listRoomTrash","summary":"List the room trash with who trashed each item and when","description":"Requires `node.trash` (edit) on the room root. One item per trash action: a folder lists the number of items trashed with it. Items whose former parent the caller may not see are omitted. `purgeBlockedBy`, `retainedUntil` and the open deletion request are filled for room managers (`node.purge`) only. Guests with edit see titles only.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":200,"description":"Page size, 1-200 (default 100)."},"required":false,"description":"Page size, 1-200 (default 100).","name":"limit","in":"query"},{"schema":{"type":"string","pattern":"^\\d{1,6}$","description":"Opaque cursor from the previous page."},"required":false,"description":"Opaque cursor from the previous page.","name":"cursor","in":"query"}],"responses":{"200":{"description":"The trash.","content":{"application/json":{"schema":{"type":"object","properties":{"trashRetentionDays":{"type":"integer","minimum":30,"maximum":365},"purgeFourEyes":{"type":"boolean"},"canRestore":{"type":"boolean","description":"The caller may restore items (edit on the room)."},"canPurge":{"type":"boolean","description":"The caller may delete items definitively (room manager)."},"items":{"type":"array","items":{"type":"object","properties":{"nodeId":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["folder","document","placeholder"]},"title":{"type":"string","nullable":true,"description":"Title for the UI; client data, never logged."},"documentId":{"type":"string","nullable":true,"format":"uuid"},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Former parent folder; null at the room root."},"restoreTarget":{"type":"string","enum":["original","root"],"description":"Where a restore puts the item: its former folder, or the room root when that is gone."},"trashedAt":{"type":"string","format":"date-time"},"trashedBy":{"type":"object","nullable":true,"properties":{"principalId":{"type":"string","format":"uuid"},"displayName":{"type":"string","nullable":true,"description":"Display name, or null when unknown."}},"required":["principalId","displayName"],"description":"Null for items trashed before this was recorded."},"descendantCount":{"type":"integer","minimum":0,"description":"Folders: items trashed together with it."},"purgeAfter":{"type":"string","format":"date-time","description":"When the automatic purge may delete it definitively (trashedAt + trash period)."},"purgeBlockedBy":{"type":"string","nullable":true,"enum":["LEGAL_HOLD","ROOM_NOT_ACTIVE","RETENTION_NOT_EXPIRED","EXHIBIT_FILING_OPEN",null],"description":"Why a definitive deletion is refused now; null for callers who may not purge."},"retainedUntil":{"type":"string","nullable":true,"format":"date","description":"Retention date inherited from the room (managers only), or null."},"purgeRequest":{"type":"object","nullable":true,"properties":{"requestId":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["requested","approved","executing","failed"],"description":"`requested` waits for the second room manager (four eyes)."},"requestedBy":{"type":"object","nullable":true,"properties":{"principalId":{"type":"string","format":"uuid"},"displayName":{"type":"string","nullable":true,"description":"Display name, or null when unknown."}},"required":["principalId","displayName"],"description":"Null for the automatic purge after the trash period."},"requestedAt":{"type":"string","format":"date-time"},"approvalsRequired":{"type":"integer","minimum":1,"maximum":2},"expiresAt":{"type":"string","format":"date-time","description":"A request that is not approved by then expires."},"failureCode":{"type":"string","nullable":true,"pattern":"^[A-Z][A-Z0-9_]{0,62}$","description":"The refusal the worker recorded, when it failed."},"canApprove":{"type":"boolean","description":"The caller may give the second approval."},"canCancel":{"type":"boolean","description":"The caller may cancel the request."}},"required":["requestId","status","requestedBy","requestedAt","approvalsRequired","expiresAt","failureCode","canApprove","canCancel"],"description":"An open definitive deletion request of one trash item."}},"required":["nodeId","kind","title","documentId","parentId","restoreTarget","trashedAt","trashedBy","descendantCount","purgeAfter","purgeBlockedBy","retainedUntil","purgeRequest"],"description":"One trash item: a document or a folder with the contents trashed together with it."},"description":"Most recently trashed first."},"nextCursor":{"type":"string","nullable":true}},"required":["trashRetentionDays","purgeFourEyes","canRestore","canPurge","items","nextCursor"],"description":"The room trash."}}}},"400":{"description":"Invalid query.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out, or stronger authentication is required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"The caller may not use the trash of this room.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/trash/restore":{"post":{"operationId":"restoreTrashItems","summary":"Restore one or more trash items","description":"Requires `node.trash` (edit) on the room root, and `node.restore` on each item. An item goes back to its former folder, or to the room root when that folder is in the trash or deleted definitively (`restored_to_root`, which also needs `node.create` on the root). Each item restores the contents trashed together with it. Writes `index_node.restored` per item. Items the caller cannot see answer `NOT_FOUND`; an item with a pending definitive deletion answers `PURGE_PENDING`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"nodeIds":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"maxItems":100}},"required":["nodeIds"],"description":"Restore one or more trash items."}}}},"responses":{"200":{"description":"One result per item.","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"nodeId":{"type":"string","format":"uuid"},"outcome":{"type":"string","enum":["restored","restored_to_root","refused"]},"code":{"type":"string","nullable":true,"enum":["LEGAL_HOLD","ROOM_NOT_ACTIVE","RETENTION_NOT_EXPIRED","EXHIBIT_FILING_OPEN","NOT_FOUND","FORBIDDEN","NOT_IN_TRASH","PURGE_PENDING","CONFLICT",null]}},"required":["nodeId","outcome","code"]}}},"required":["results"],"description":"One result per requested item, in request order."}}}},"400":{"description":"Invalid body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out, or stronger authentication is required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"The caller may not use the trash of this room.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/trash/purge":{"post":{"operationId":"purgeTrashItems","summary":"Delete one or more trash items definitively (Definitief verwijderen)","description":"Requires `node.purge` (room manager, users only, step-up) on each item, and `confirm: true`. Refused per item, in the ADR-0012 D11.1 order, with `LEGAL_HOLD` (a hold or a lift in its 7-day grace covers the room), `ROOM_NOT_ACTIVE`, `RETENTION_NOT_EXPIRED` (the room retention date has not passed) and `EXHIBIT_FILING_OPEN`; `PURGE_PENDING` when a request is already open. Without four eyes the request is `queued` and the worker deletes the item shortly: it re-checks every rule, destroys the data-key wrap of every blob no other document or filing references (a shared blob stays), scrubs file names and titles, places delete markers and completes a deletion record with a certificate hash. With four eyes the request is `awaiting_approval`. Writes `deletion_request.created`; audit events are never changed.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"nodeIds":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"maxItems":100},"confirm":{"type":"boolean","enum":[true],"description":"The caller confirmed that the deletion is irreversible (the UI asks explicitly)."}},"required":["nodeIds","confirm"],"description":"Delete one or more trash items definitively."}}}},"responses":{"202":{"description":"One result per item.","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"nodeId":{"type":"string","format":"uuid"},"outcome":{"type":"string","enum":["queued","awaiting_approval","refused"],"description":"`queued`: the worker deletes it shortly; `awaiting_approval`: four eyes."},"code":{"type":"string","nullable":true,"enum":["LEGAL_HOLD","ROOM_NOT_ACTIVE","RETENTION_NOT_EXPIRED","EXHIBIT_FILING_OPEN","NOT_FOUND","FORBIDDEN","NOT_IN_TRASH","PURGE_PENDING","CONFLICT",null]},"requestId":{"type":"string","nullable":true,"format":"uuid"}},"required":["nodeId","outcome","code","requestId"]}}},"required":["results"],"description":"One result per requested item, in request order."}}}},"400":{"description":"Invalid body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out, or stronger authentication is required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"The caller may not use the trash of this room.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/trash/purge-requests/{requestId}/approve":{"post":{"operationId":"approveTrashPurge","summary":"Give the second approval for a definitive deletion (four eyes)","description":"Requires `node.purge.approve` (room manager, step-up) on the item; the approver is never the requester (`APPROVER_IS_REQUESTER`). Re-checks the hold, room state and retention first (409 with the D11.1 code), then `REQUEST_NOT_PENDING` or `REQUEST_EXPIRED`. Writes `deletion_request.approved`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Definitive deletion request id."},"required":true,"description":"Definitive deletion request id.","name":"requestId","in":"path"}],"responses":{"200":{"description":"Approved; the worker deletes the item shortly.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["requested","approved","executing","failed"],"description":"`requested` waits for the second room manager (four eyes)."},"requestedBy":{"type":"object","nullable":true,"properties":{"principalId":{"type":"string","format":"uuid"},"displayName":{"type":"string","nullable":true,"description":"Display name, or null when unknown."}},"required":["principalId","displayName"],"description":"Null for the automatic purge after the trash period."},"requestedAt":{"type":"string","format":"date-time"},"approvalsRequired":{"type":"integer","minimum":1,"maximum":2},"expiresAt":{"type":"string","format":"date-time","description":"A request that is not approved by then expires."},"failureCode":{"type":"string","nullable":true,"pattern":"^[A-Z][A-Z0-9_]{0,62}$","description":"The refusal the worker recorded, when it failed."},"canApprove":{"type":"boolean","description":"The caller may give the second approval."},"canCancel":{"type":"boolean","description":"The caller may cancel the request."}},"required":["requestId","status","requestedBy","requestedAt","approvalsRequired","expiresAt","failureCode","canApprove","canCancel"],"description":"An open definitive deletion request of one trash item."}}}},"401":{"description":"Signed out, or stronger authentication is required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"The caller may not use the trash of this room.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Refused (D11.1 code).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/trash/purge-requests/{requestId}/cancel":{"post":{"operationId":"cancelTrashPurge","summary":"Cancel an open definitive deletion request","description":"Requires `node.purge` (room manager) on the item. Only a request that is still `requested` or `approved` and not yet executing can be cancelled (`REQUEST_NOT_PENDING`). Writes `deletion_request.cancelled`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Definitive deletion request id."},"required":true,"description":"Definitive deletion request id.","name":"requestId","in":"path"}],"responses":{"204":{"description":"Cancelled."},"401":{"description":"Signed out, or stronger authentication is required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"The caller may not use the trash of this room.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"The request is no longer open.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/engagement":{"post":{"operationId":"reportDocumentEngagement","summary":"Report page dwell time from the viewer (heartbeat)","description":"Requires `document.view` on the document for the caller (firm user or guest). Adds the seconds per page to the caller’s aggregate row of (version, page, day); each sample is at most 60 s and a heartbeat at most 120 s in total (the excess is dropped), pages beyond the version’s page count are ignored. No audit event per heartbeat (the page views are audited when served). Rate limited per principal. A caller without access gets 404 (PERM-02).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"versionNo":{"type":"integer","minimum":1,"description":"Version shown; default the current version."},"samples":{"type":"array","items":{"type":"object","properties":{"pageNo":{"type":"integer","minimum":1,"maximum":100000,"description":"1-based page number."},"seconds":{"type":"integer","minimum":1,"maximum":60,"description":"Whole seconds the page was visible since the previous report."}},"required":["pageNo","seconds"],"additionalProperties":false,"description":"Dwell time on one page."},"minItems":1,"maxItems":50}},"required":["samples"],"additionalProperties":false,"description":"One viewer heartbeat: dwell time per page since the previous report."}}}},"responses":{"204":{"description":"Recorded (or silently clamped)."},"400":{"description":"Invalid body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Too many heartbeats; see Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/insights":{"get":{"operationId":"getRoomInsights","summary":"Room engagement insights per group, document and folder","description":"Firm users with `audit.read_room` on the room only (room managers, firm admins, compliance); a guest or any other caller gets 404. Per group (external first): people with engagement, documents viewed, total time and last activity; per document and folder the time per group (heatmap) and the distinct viewers, most viewed first. Titles and group names are resolved at read time as the caller may read them.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","enum":["7","30","90","365"],"description":"Period in days, ending today (Europe/Amsterdam). Default 30."},"required":false,"description":"Period in days, ending today (Europe/Amsterdam). Default 30.","name":"days","in":"query"}],"responses":{"200":{"description":"The insights for the period.","content":{"application/json":{"schema":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid"},"days":{"type":"integer","minimum":1},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"groups":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group; null for firm users without a group in this room."},"name":{"type":"string","nullable":true,"description":"Group name; null for an unnamed or no group."},"kind":{"type":"string","nullable":true,"enum":["internal","client","counterparty","expert","custom_external",null],"description":"Group kind (ADR-0005 §4). Everything except `internal` is an external group."},"external":{"type":"boolean","description":"True for every group kind except internal."},"principals":{"type":"integer","minimum":0,"description":"People of the group with any engagement."},"documentsViewed":{"type":"integer","minimum":0},"totalSeconds":{"type":"integer","minimum":0},"lastActivityAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["groupId","name","kind","external","principals","documentsViewed","totalSeconds","lastActivityAt"]},"description":"External groups first, then internal ones."},"documents":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid"},"nodeId":{"type":"string","nullable":true,"format":"uuid"},"title":{"type":"string","nullable":true},"folderId":{"type":"string","nullable":true,"format":"uuid","description":"Parent folder of the document; null at the room root."},"totalSeconds":{"type":"integer","minimum":0},"viewers":{"type":"integer","minimum":0,"description":"Distinct people with engagement."},"downloads":{"type":"integer","minimum":0,"description":"Downloads and prints of the document in the period, from the audit trail (ADR-0066)."},"lastActivityAt":{"type":"string","nullable":true,"format":"date-time"},"groups":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group; null for firm users without a group in this room."},"seconds":{"type":"integer","minimum":0}},"required":["groupId","seconds"]}}},"required":["documentId","nodeId","title","folderId","totalSeconds","viewers","lastActivityAt","groups"]},"description":"Most viewed first (total time)."},"folders":{"type":"array","items":{"type":"object","properties":{"folderId":{"type":"string","nullable":true,"format":"uuid","description":"Folder; null for documents at the room root."},"title":{"type":"string","nullable":true},"totalSeconds":{"type":"integer","minimum":0},"groups":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group; null for firm users without a group in this room."},"seconds":{"type":"integer","minimum":0}},"required":["groupId","seconds"]}}},"required":["folderId","title","totalSeconds","groups"]},"description":"Folders of the documents above, most viewed first."}},"required":["roomId","days","from","to","groups","documents","folders"],"description":"Room engagement per group, document and folder for the period."}}}},"400":{"description":"Invalid query.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or document, a guest, or a firm user without `audit.read_room` on the room (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/insights/documents/{documentId}":{"get":{"operationId":"getDocumentInsights","summary":"Engagement per page and group for one document, with the per-person detail","description":"Same access as `getRoomInsights`. Time per page per group over all versions of the document, the group totals and the per-person detail (display name, group, time, pages viewed, last activity).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"},{"schema":{"type":"string","enum":["7","30","90","365"],"description":"Period in days, ending today (Europe/Amsterdam). Default 30."},"required":false,"description":"Period in days, ending today (Europe/Amsterdam). Default 30.","name":"days","in":"query"}],"responses":{"200":{"description":"The document insights for the period.","content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid"},"title":{"type":"string","nullable":true},"days":{"type":"integer","minimum":1},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"groups":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group; null for firm users without a group in this room."},"name":{"type":"string","nullable":true,"description":"Group name; null for an unnamed or no group."},"kind":{"type":"string","nullable":true,"enum":["internal","client","counterparty","expert","custom_external",null],"description":"Group kind (ADR-0005 §4). Everything except `internal` is an external group."},"external":{"type":"boolean","description":"True for every group kind except internal."},"principals":{"type":"integer","minimum":0,"description":"People of the group with any engagement."},"documentsViewed":{"type":"integer","minimum":0},"totalSeconds":{"type":"integer","minimum":0},"lastActivityAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["groupId","name","kind","external","principals","documentsViewed","totalSeconds","lastActivityAt"]}},"pages":{"type":"array","items":{"type":"object","properties":{"pageNo":{"type":"integer","minimum":1},"totalSeconds":{"type":"integer","minimum":0},"groups":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group; null for firm users without a group in this room."},"seconds":{"type":"integer","minimum":0}},"required":["groupId","seconds"]}}},"required":["pageNo","totalSeconds","groups"]},"description":"Pages with engagement, in page order."},"people":{"type":"array","items":{"type":"object","properties":{"principalId":{"type":"string","format":"uuid"},"displayName":{"type":"string","nullable":true},"kind":{"type":"string","enum":["user","guest"]},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group; null for firm users without a group in this room."},"seconds":{"type":"integer","minimum":0},"pagesViewed":{"type":"integer","minimum":0},"lastActivityAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["principalId","displayName","kind","groupId","seconds","pagesViewed","lastActivityAt"]},"description":"Per-person detail, most time first."}},"required":["documentId","title","days","from","to","groups","pages","people"],"description":"Engagement per page and group for one document (all versions) in the period."}}}},"400":{"description":"Invalid query.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or document, a guest, or a firm user without `audit.read_room` on the room (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/insights/export":{"get":{"operationId":"exportRoomInsights","summary":"Export the room insights as CSV","description":"Same access as `getRoomInsights`. `format=csv` (default): one row per document and group (folder, document, group, group kind, seconds, minutes, viewers, last activity), UTF-8 with BOM, `;`-separated. `format=xlsx`: a workbook with the sheets documents, people and Q&A. Writes `export.downloaded` (export kind `engagement_report`) before the first byte (fail closed with 503).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","enum":["7","30","90","365"],"description":"Period in days, ending today (Europe/Amsterdam). Default 30."},"required":false,"description":"Period in days, ending today (Europe/Amsterdam). Default 30.","name":"days","in":"query"},{"schema":{"type":"string","enum":["nl","en"],"description":"Language of the column headings; default nl."},"required":false,"description":"Language of the column headings; default nl.","name":"lang","in":"query"},{"schema":{"type":"string","enum":["csv","xlsx"],"description":"`csv` (default): one row per document and group. `xlsx`: a workbook with the sheets documents, people and Q&A (ADR-0066)."},"required":false,"description":"`csv` (default): one row per document and group. `xlsx`: a workbook with the sheets documents, people and Q&A (ADR-0066).","name":"format","in":"query"}],"responses":{"200":{"description":"The CSV file.","headers":{"Content-Disposition":{"schema":{"type":"string","description":"`attachment` with a file name made of the date only."},"required":true,"description":"`attachment` with a file name made of the date only."},"Cache-Control":{"schema":{"type":"string","enum":["no-store"],"description":"Never cached."},"required":true,"description":"Never cached."}},"content":{"text/csv":{"schema":{"type":"string","description":"The CSV text."}},"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","description":"The Excel workbook (binary)."}}}},"400":{"description":"Invalid query.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or document, a guest, or a firm user without `audit.read_room` on the room (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"The audit event could not be written; nothing was served.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/redaction/matches":{"post":{"operationId":"findRedactionMatches","summary":"Find areas for search terms and pattern suggestions","description":"`document.redact` (`edit`, firm users only) on the document node. Matches the terms (case and accent insensitive) and the patterns (BSN with the eleven-test, IBAN with mod 97, dates near a birth keyword) against the word boxes of the current version and returns proposed areas for review. The word boxes are extracted by the worker on first use: 202 `LAYOUT_PENDING` with Retry-After until they exist. Terms are never stored or logged; writes `redaction.searched` with counts only. 409 `CONFLICT` when `versionId` is not the current available version.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","description":"The version the areas are prepared on (the current version)."},"terms":{"type":"array","items":{"type":"string","minLength":2,"maxLength":100},"maxItems":20,"default":[],"description":"Search terms (case and accent insensitive); never stored or logged."},"patterns":{"type":"array","items":{"type":"string","enum":["bsn","iban","birth_date"],"description":"Pattern suggestion: BSN (eleven-test), IBAN (mod 97) or a date of birth."},"maxItems":3,"default":[],"description":"Pattern suggestions to run."}},"required":["versionId"],"additionalProperties":false,"description":"Find the areas of search terms and pattern suggestions."}}}},"responses":{"200":{"description":"Proposed areas.","content":{"application/json":{"schema":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid"},"pageCount":{"type":"integer","minimum":0},"matches":{"type":"array","items":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000,"description":"1-based page number."},"x":{"type":"number","minimum":0,"maximum":1,"description":"Left edge as a fraction of the page width."},"y":{"type":"number","minimum":0,"maximum":1,"description":"Top edge as a fraction of the page height."},"w":{"type":"number","minimum":0,"exclusiveMinimum":true,"maximum":1,"description":"Width as a fraction of the page width."},"h":{"type":"number","minimum":0,"exclusiveMinimum":true,"maximum":1,"description":"Height as a fraction of the page height."},"kind":{"type":"string","enum":["term","bsn","iban","birth_date"]},"term":{"type":"integer","nullable":true,"minimum":0,"description":"Index of the matched search term; null for a pattern."}},"required":["page","x","y","w","h","kind","term"],"additionalProperties":false,"description":"One proposed area (a word box, or several joined on one line)."},"maxItems":5000},"truncated":{"type":"boolean","description":"More matches exist than returned."}},"required":["versionId","pageCount","matches","truncated"],"additionalProperties":false,"description":"Proposed areas; the client shows them for review before applying."}}}},"202":{"description":"`LAYOUT_PENDING`: the word boxes are being extracted; retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"The caller sees the document but lacks the `edit` level (or is not a firm user).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or document, no access, a guest, or cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"`CONFLICT` (not the current version) or `READ_ONLY`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/redactions":{"post":{"operationId":"applyRedaction","summary":"Burn redactions into a new version","description":"`document.redact` (`edit`, firm users only) on the document node. Rebuilds the current version as an image-only PDF from its page images with every area painted black (the text under an area is removed, not hidden), stores it encrypted as version n+1 with `reason = redaction` (it then runs the normal scan pipeline) and marks every earlier version internal-only: guests never read them again. The justification is stored in the firm-only redaction log. Writes `redaction.applied` (version ids, counts and the justification length only). 202 `PAGE_RENDERING` with Retry-After while page images are still being rendered (nothing is written; retry the same request). 409 `CONFLICT` when `versionId` is not the current available version, `PDF_UNAVAILABLE` when the version has no page preview.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","description":"The version the areas were drawn on; must still be the current version."},"areas":{"type":"array","items":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000,"description":"1-based page number."},"x":{"type":"number","minimum":0,"maximum":1,"description":"Left edge as a fraction of the page width."},"y":{"type":"number","minimum":0,"maximum":1,"description":"Top edge as a fraction of the page height."},"w":{"type":"number","minimum":0,"exclusiveMinimum":true,"maximum":1,"description":"Width as a fraction of the page width."},"h":{"type":"number","minimum":0,"exclusiveMinimum":true,"maximum":1,"description":"Height as a fraction of the page height."}},"required":["page","x","y","w","h"],"additionalProperties":false,"description":"One rectangle to burn in, in page fractions (origin top left)."},"minItems":1,"maxItems":2000},"reason":{"type":"string","minLength":3,"maxLength":2000,"description":"Mandatory justification (client data; stored in the firm-only redaction log)."},"termCount":{"type":"integer","minimum":0,"maximum":20,"default":0,"description":"Search terms used."},"suggestionCount":{"type":"integer","minimum":0,"maximum":2000,"default":0,"description":"Accepted pattern suggestions."}},"required":["versionId","areas","reason"],"additionalProperties":false,"description":"Burn the areas into a new version."}}}},"responses":{"201":{"description":"Applied.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"sourceVersionId":{"type":"string","format":"uuid"},"sourceVersionNo":{"type":"integer","nullable":true,"minimum":1},"resultVersionId":{"type":"string","format":"uuid"},"resultVersionNo":{"type":"integer","nullable":true,"minimum":1},"areaCount":{"type":"integer","minimum":1},"termCount":{"type":"integer","minimum":0},"suggestionCount":{"type":"integer","minimum":0},"pageCount":{"type":"integer","minimum":1},"reason":{"type":"string","nullable":true,"description":"The justification (client data); null once scrubbed."},"createdBy":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","nullable":true}},"required":["id","displayName"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"}},"required":["id","documentId","sourceVersionId","sourceVersionNo","resultVersionId","resultVersionNo","areaCount","termCount","suggestionCount","pageCount","reason","createdBy","createdAt"],"additionalProperties":false,"description":"One applied redaction (redaction log entry)."}}}},"202":{"description":"`PAGE_RENDERING`: retry shortly.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"`STEP_UP_REQUIRED`: stronger authentication is required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"The caller sees the document but lacks the `edit` level (or is not a firm user).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or document, no access, a guest, or cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"`CONFLICT` (not the current version), `PDF_UNAVAILABLE` or `READ_ONLY`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"413":{"description":"`STORAGE_POOL_EXHAUSTED`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"get":{"operationId":"listRedactions","summary":"Read the redaction log of a document","description":"`document.redaction.read` (`view`, firm users only) on the document node. Newest first with a keyset cursor and the justification; `truncated` is true when the cap holds more entries than were returned, so a capped log is never mistaken for the whole log. Guests get 404.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"},{"schema":{"type":"string","maxLength":512,"description":"Opaque keyset cursor from the previous page; omit it for the newest page."},"required":false,"description":"Opaque keyset cursor from the previous page; omit it for the newest page.","name":"cursor","in":"query"}],"responses":{"200":{"description":"The log with an explicit partial signal.","content":{"application/json":{"schema":{"type":"object","properties":{"redactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"sourceVersionId":{"type":"string","format":"uuid"},"sourceVersionNo":{"type":"integer","nullable":true,"minimum":1},"resultVersionId":{"type":"string","format":"uuid"},"resultVersionNo":{"type":"integer","nullable":true,"minimum":1},"areaCount":{"type":"integer","minimum":1},"termCount":{"type":"integer","minimum":0},"suggestionCount":{"type":"integer","minimum":0},"pageCount":{"type":"integer","minimum":1},"reason":{"type":"string","nullable":true,"description":"The justification (client data); null once scrubbed."},"createdBy":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","nullable":true}},"required":["id","displayName"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"}},"required":["id","documentId","sourceVersionId","sourceVersionNo","resultVersionId","resultVersionNo","areaCount","termCount","suggestionCount","pageCount","reason","createdBy","createdAt"],"additionalProperties":false,"description":"One applied redaction (redaction log entry)."}},"truncated":{"type":"boolean","default":false,"description":"True when more log entries exist than were returned (the log is partial). The server always sends an explicit value; the default keeps older bare payloads parseable as complete."},"nextCursor":{"type":"string","nullable":true,"default":null,"description":"Opaque cursor for the next (older) page; null on the last page."}},"required":["redactions"],"additionalProperties":false,"description":"The redaction log of a document, newest first with an explicit partial signal."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or document, no access, a guest, or cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/privilege":{"put":{"operationId":"setDocumentPrivilege","summary":"Tag or untag a document as privileged","description":"`document.privilege.set` (`edit`, firm users only) on the document node. A privileged document is internal for the central policy and hidden by row-level security from every guest session: guests never see, download or find it, whatever the folder permissions; its watermark gains a `PRIVILEGED` line. Writes `document.privilege_marked` / `document.privilege_unmarked`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"privileged":{"type":"boolean","description":"Tag (true) or untag (false) the document."}},"required":["privileged"],"additionalProperties":false,"description":"Set the privilege tag of a document."}}}},"responses":{"200":{"description":"The tag.","content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid"},"nodeId":{"type":"string","format":"uuid"},"privileged":{"type":"boolean"}},"required":["documentId","nodeId","privileged"],"additionalProperties":false,"description":"The privilege tag of a document."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"`STEP_UP_REQUIRED`: stronger authentication is required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"The caller sees the document but lacks the `edit` level (or is not a firm user).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or document, no access, a guest, or cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"`READ_ONLY`: the room is not active.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/privilege-log":{"get":{"operationId":"exportPrivilegeLog","summary":"Export the privilege log of a room (CSV)","description":"`room.privilege_log.export` (`manage` on the room, firm users only). One row per privileged document: index number, title, current version, tagged since and by whom, and the number of redactions. Writes `privilege_log.exported` (count only) before the first byte.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","enum":["nl","en"],"description":"Language of the CSV header row; default nl."},"required":false,"description":"Language of the CSV header row; default nl.","name":"locale","in":"query"}],"responses":{"200":{"description":"The CSV (UTF-8 with BOM, comma separated, formula-safe).","headers":{"Content-Disposition":{"schema":{"type":"string","description":"`attachment` with a file name made of the date only."},"required":true,"description":"`attachment` with a file name made of the date only."},"Cache-Control":{"schema":{"type":"string","enum":["no-store"]},"required":true}},"content":{"text/csv":{"schema":{"type":"string"}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"A room member without `manage`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or document, no access, a guest, or cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"The audit event could not be written; nothing was served.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/client-workspace/{token}":{"get":{"operationId":"getClientWorkspace","summary":"Read the client workspace of an invitation link","description":"The workspace of the invited client in the invitation’s room (ADR-0047). The link is never a credential (ADR-0003 D6): the caller needs a guest session of the identity the invitation was sent to (requestGuestCode / signInWithGuestCode with the same token). Requires `room.read` allowed or `step_up_required` on the room (a client without a live membership gets 404); the requests list only items the policy lets the client read (`flow_item.read`, single strength). `shared` says whether the shared folders need the SMS step first (ADR-0026 D3). The first read of a request per session writes flow.link_opened.","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Link token from the request e-mail. Never a credential on its own."},"required":true,"description":"Link token from the request e-mail. Never a credential on its own.","name":"token","in":"path"}],"responses":{"200":{"description":"The workspace.","content":{"application/json":{"schema":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"room":{"type":"object","properties":{"name":{"type":"string","nullable":true}},"required":["name"]},"subjectPrincipalId":{"type":"string","format":"uuid"},"firm":{"type":"object","properties":{"name":{"type":"string"},"initials":{"type":"string","maxLength":4},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Firm vertical: legal (law firm) or mortgage (mortgage adviser)."}},"required":["name","initials"]},"clientName":{"type":"string","nullable":true},"authStrength":{"type":"string","enum":["single","mfa"],"description":"Strength of the session in this tenant."},"freeBranding":{"type":"boolean"},"shared":{"type":"string","enum":["open","step_up_required"],"description":"`open`: the shared folders and documents can be listed (`room.read` allowed); `step_up_required`: the SMS code is needed first (ADR-0026 D3)."},"smsAvailable":{"type":"boolean","description":"The firm entered a mobile number for the SMS step."},"requests":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipientName":{"type":"string"},"applicantSlot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"The applicant slot this guest link is bound to (M2/HYP-03). Absent on a legacy single-recipient link, where the guest may fill every slot; present on a shared request, where the view carries only this slot’s private files and answers."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."}},"required":["slot","label"],"additionalProperties":false},"description":"Named room parties of this request (WF01): slot and display label only, so a party learns no internal group id. Empty on legacy rows."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): this portal shares every bound slot’s drafts. False keeps the slot-private view."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance (ids and period keys only). Null on legacy rows without a period."},"firm":{"type":"object","properties":{"name":{"type":"string"},"initials":{"type":"string","maxLength":4},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Vertical of the firm that owns the request (ADR-0030); drives the mortgage upload notices."},"logoUrl":{"type":"string","maxLength":300,"description":"Same-origin URL of the firm logo (public branding asset), when the firm set one."}},"required":["name","initials"]},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"claimReceipt":{"type":"object","properties":{"status":{"type":"string","enum":["not_submitted","received","correction_requested","under_review"],"description":"Guest-safe creditor claim status (WF04); never an internal acceptance or ranking."},"reference":{"type":"string","nullable":true,"maxLength":100,"description":"The creditor's own claim reference, echoed back; null until it is filed."},"itemCount":{"type":"integer","minimum":0,"description":"Items of the claim request."},"submittedCount":{"type":"integer","minimum":0,"description":"Items delivered so far."},"correctionCount":{"type":"integer","minimum":0,"description":"Items the firm sent back for correction."},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"First/last submit time of the claim; null when none."}},"required":["status","reference","itemCount","submittedCount","correctionCount","submittedAt"],"additionalProperties":false,"description":"Own receipt and guest-safe status of a creditor claim (WF04); present on insolvency creditor requests, absent elsewhere. Never carries another creditor data."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number"],"description":"Request item as the client sees it."}},"id":{"type":"string","format":"uuid","description":"Request id (addresses the item actions of the workspace)."},"sentAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["title","message","status","dueDate","recipientName","parties","joint","periodContext","firm","submittedAt","expiresAt","coverInstructions","displayStatus","progress","sections","items","id","sentAt"],"description":"A document request in the client workspace."}},"uploads":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Request file id."},"requestId":{"type":"string","format":"uuid"},"requestTitle":{"type":"string"},"itemTitle":{"type":"string"},"name":{"type":"string","description":"Original file name (client data)."},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["in_review","approved","rejected"],"description":"Review state of a sent file: waiting for the firm, approved, or sent back."},"reject":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true}},"required":["reasonCode","note"],"description":"Why the firm sent the item back; null unless `rejected`."},"fingerprint":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the received plaintext (receipt); null while the upload is still being stored."}},"required":["id","requestId","requestTitle","itemTitle","name","size","uploadedAt","status","reject","fingerprint"],"description":"One file the client sent, with its review state and receipt."}},"timeline":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["invited","accepted","request_sent","documents_sent","item_approved","item_rejected","item_not_applicable","request_completed"]},"at":{"type":"string","format":"date-time"},"title":{"type":"string","nullable":true,"description":"Request or item title (client data); null for the invitation."}},"required":["kind","at","title"],"description":"One step of the matter as the client sees it."}}},"required":["tenantId","roomId","room","firm","clientName","authStrength","shared","smsAvailable","requests","uploads","timeline"],"description":"The client workspace of one client in one room."}}}},"401":{"description":"Sign in with the e-mail code first: UNAUTHENTICATED without a session, EMAIL_CODE_REQUIRED with a session of another identity or a firm user.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown, expired or revoked link, or no access to the room.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/client-workspace/{token}/requests/{flowId}/items/{itemId}/files":{"post":{"operationId":"uploadClientWorkspaceFile","summary":"Upload a file into a request item from the workspace (draft)","description":"Same as uploadPortalFile, addressed by the invitation link and the request id: the raw file (application/octet-stream, at most 100 MiB) with its name percent-encoded in x-ddr-filename. Requires flow_item.submit on the item. Encrypted in the guest intake transaction (ADR-0025) and kept out of the room index until the firm approves. Writes document_version.uploaded as the guest.","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Link token from the request e-mail. Never a credential on its own."},"required":true,"description":"Link token from the request e-mail. Never a credential on its own.","name":"token","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"}],"requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string","description":"The raw file bytes."}}}},"responses":{"201":{"description":"Updated request.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipientName":{"type":"string"},"applicantSlot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"The applicant slot this guest link is bound to (M2/HYP-03). Absent on a legacy single-recipient link, where the guest may fill every slot; present on a shared request, where the view carries only this slot’s private files and answers."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."}},"required":["slot","label"],"additionalProperties":false},"description":"Named room parties of this request (WF01): slot and display label only, so a party learns no internal group id. Empty on legacy rows."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): this portal shares every bound slot’s drafts. False keeps the slot-private view."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance (ids and period keys only). Null on legacy rows without a period."},"firm":{"type":"object","properties":{"name":{"type":"string"},"initials":{"type":"string","maxLength":4},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Vertical of the firm that owns the request (ADR-0030); drives the mortgage upload notices."},"logoUrl":{"type":"string","maxLength":300,"description":"Same-origin URL of the firm logo (public branding asset), when the firm set one."}},"required":["name","initials"]},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"claimReceipt":{"type":"object","properties":{"status":{"type":"string","enum":["not_submitted","received","correction_requested","under_review"],"description":"Guest-safe creditor claim status (WF04); never an internal acceptance or ranking."},"reference":{"type":"string","nullable":true,"maxLength":100,"description":"The creditor's own claim reference, echoed back; null until it is filed."},"itemCount":{"type":"integer","minimum":0,"description":"Items of the claim request."},"submittedCount":{"type":"integer","minimum":0,"description":"Items delivered so far."},"correctionCount":{"type":"integer","minimum":0,"description":"Items the firm sent back for correction."},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"First/last submit time of the claim; null when none."}},"required":["status","reference","itemCount","submittedCount","correctionCount","submittedAt"],"additionalProperties":false,"description":"Own receipt and guest-safe status of a creditor claim (WF04); present on insolvency creditor requests, absent elsewhere. Never carries another creditor data."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number"],"description":"Request item as the client sees it."}},"id":{"type":"string","format":"uuid","description":"Request id (addresses the item actions of the workspace)."},"sentAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["title","message","status","dueDate","recipientName","parties","joint","periodContext","firm","submittedAt","expiresAt","coverInstructions","displayStatus","progress","sections","items","id","sentAt"],"description":"A document request in the client workspace."}}}},"400":{"description":"Missing file name or empty body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Sign in with the e-mail code first: UNAUTHENTICATED without a session, EMAIL_CODE_REQUIRED with a session of another identity or a firm user.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown, expired or revoked link, or a request or item that is not this client’s.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"ITEM_NOT_OPEN.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"413":{"description":"STORAGE_POOL_EXHAUSTED or too large.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/client-workspace/{token}/requests/{flowId}/items/{itemId}/files/{fileId}":{"delete":{"operationId":"removeClientWorkspaceFile","summary":"Remove an own draft file from the workspace","description":"Same as removePortalFile. Requires flow_item.submit. Writes flow_item.draft_file_removed.","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Link token from the request e-mail. Never a credential on its own."},"required":true,"description":"Link token from the request e-mail. Never a credential on its own.","name":"token","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"fileId","in":"path"}],"responses":{"200":{"description":"Updated request.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipientName":{"type":"string"},"applicantSlot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"The applicant slot this guest link is bound to (M2/HYP-03). Absent on a legacy single-recipient link, where the guest may fill every slot; present on a shared request, where the view carries only this slot’s private files and answers."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."}},"required":["slot","label"],"additionalProperties":false},"description":"Named room parties of this request (WF01): slot and display label only, so a party learns no internal group id. Empty on legacy rows."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): this portal shares every bound slot’s drafts. False keeps the slot-private view."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance (ids and period keys only). Null on legacy rows without a period."},"firm":{"type":"object","properties":{"name":{"type":"string"},"initials":{"type":"string","maxLength":4},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Vertical of the firm that owns the request (ADR-0030); drives the mortgage upload notices."},"logoUrl":{"type":"string","maxLength":300,"description":"Same-origin URL of the firm logo (public branding asset), when the firm set one."}},"required":["name","initials"]},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"claimReceipt":{"type":"object","properties":{"status":{"type":"string","enum":["not_submitted","received","correction_requested","under_review"],"description":"Guest-safe creditor claim status (WF04); never an internal acceptance or ranking."},"reference":{"type":"string","nullable":true,"maxLength":100,"description":"The creditor's own claim reference, echoed back; null until it is filed."},"itemCount":{"type":"integer","minimum":0,"description":"Items of the claim request."},"submittedCount":{"type":"integer","minimum":0,"description":"Items delivered so far."},"correctionCount":{"type":"integer","minimum":0,"description":"Items the firm sent back for correction."},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"First/last submit time of the claim; null when none."}},"required":["status","reference","itemCount","submittedCount","correctionCount","submittedAt"],"additionalProperties":false,"description":"Own receipt and guest-safe status of a creditor claim (WF04); present on insolvency creditor requests, absent elsewhere. Never carries another creditor data."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number"],"description":"Request item as the client sees it."}},"id":{"type":"string","format":"uuid","description":"Request id (addresses the item actions of the workspace)."},"sentAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["title","message","status","dueDate","recipientName","parties","joint","periodContext","firm","submittedAt","expiresAt","coverInstructions","displayStatus","progress","sections","items","id","sentAt"],"description":"A document request in the client workspace."}}}},"401":{"description":"Sign in with the e-mail code first: UNAUTHENTICATED without a session, EMAIL_CODE_REQUIRED with a session of another identity or a firm user.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown, expired or revoked link, or a request or item that is not this client’s.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"ITEM_NOT_OPEN.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/client-workspace/{token}/requests/{flowId}/items/{itemId}/not-applicable":{"put":{"operationId":"markClientWorkspaceNotApplicable","summary":"Mark an item not applicable from the workspace (draft)","description":"Same as markPortalNotApplicable. Requires flow_item.respond (single strength).","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Link token from the request e-mail. Never a credential on its own."},"required":true,"description":"Link token from the request e-mail. Never a credential on its own.","name":"token","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000}},"required":["reasonCode","note"],"additionalProperties":false,"description":"Mark an item not applicable (a draft until the client sends the request)."}}}},"responses":{"200":{"description":"Updated request.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipientName":{"type":"string"},"applicantSlot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"The applicant slot this guest link is bound to (M2/HYP-03). Absent on a legacy single-recipient link, where the guest may fill every slot; present on a shared request, where the view carries only this slot’s private files and answers."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."}},"required":["slot","label"],"additionalProperties":false},"description":"Named room parties of this request (WF01): slot and display label only, so a party learns no internal group id. Empty on legacy rows."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): this portal shares every bound slot’s drafts. False keeps the slot-private view."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance (ids and period keys only). Null on legacy rows without a period."},"firm":{"type":"object","properties":{"name":{"type":"string"},"initials":{"type":"string","maxLength":4},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Vertical of the firm that owns the request (ADR-0030); drives the mortgage upload notices."},"logoUrl":{"type":"string","maxLength":300,"description":"Same-origin URL of the firm logo (public branding asset), when the firm set one."}},"required":["name","initials"]},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"claimReceipt":{"type":"object","properties":{"status":{"type":"string","enum":["not_submitted","received","correction_requested","under_review"],"description":"Guest-safe creditor claim status (WF04); never an internal acceptance or ranking."},"reference":{"type":"string","nullable":true,"maxLength":100,"description":"The creditor's own claim reference, echoed back; null until it is filed."},"itemCount":{"type":"integer","minimum":0,"description":"Items of the claim request."},"submittedCount":{"type":"integer","minimum":0,"description":"Items delivered so far."},"correctionCount":{"type":"integer","minimum":0,"description":"Items the firm sent back for correction."},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"First/last submit time of the claim; null when none."}},"required":["status","reference","itemCount","submittedCount","correctionCount","submittedAt"],"additionalProperties":false,"description":"Own receipt and guest-safe status of a creditor claim (WF04); present on insolvency creditor requests, absent elsewhere. Never carries another creditor data."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number"],"description":"Request item as the client sees it."}},"id":{"type":"string","format":"uuid","description":"Request id (addresses the item actions of the workspace)."},"sentAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["title","message","status","dueDate","recipientName","parties","joint","periodContext","firm","submittedAt","expiresAt","coverInstructions","displayStatus","progress","sections","items","id","sentAt"],"description":"A document request in the client workspace."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Sign in with the e-mail code first: UNAUTHENTICATED without a session, EMAIL_CODE_REQUIRED with a session of another identity or a firm user.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown, expired or revoked link, or a request or item that is not this client’s.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"ITEM_NOT_OPEN.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"delete":{"operationId":"clearClientWorkspaceNotApplicable","summary":"Withdraw a draft not-applicable claim from the workspace","description":"Same as clearPortalNotApplicable. Requires flow_item.respond on an open item.","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Link token from the request e-mail. Never a credential on its own."},"required":true,"description":"Link token from the request e-mail. Never a credential on its own.","name":"token","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"}],"responses":{"200":{"description":"Updated request.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipientName":{"type":"string"},"applicantSlot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"The applicant slot this guest link is bound to (M2/HYP-03). Absent on a legacy single-recipient link, where the guest may fill every slot; present on a shared request, where the view carries only this slot’s private files and answers."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."}},"required":["slot","label"],"additionalProperties":false},"description":"Named room parties of this request (WF01): slot and display label only, so a party learns no internal group id. Empty on legacy rows."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): this portal shares every bound slot’s drafts. False keeps the slot-private view."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance (ids and period keys only). Null on legacy rows without a period."},"firm":{"type":"object","properties":{"name":{"type":"string"},"initials":{"type":"string","maxLength":4},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Vertical of the firm that owns the request (ADR-0030); drives the mortgage upload notices."},"logoUrl":{"type":"string","maxLength":300,"description":"Same-origin URL of the firm logo (public branding asset), when the firm set one."}},"required":["name","initials"]},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"claimReceipt":{"type":"object","properties":{"status":{"type":"string","enum":["not_submitted","received","correction_requested","under_review"],"description":"Guest-safe creditor claim status (WF04); never an internal acceptance or ranking."},"reference":{"type":"string","nullable":true,"maxLength":100,"description":"The creditor's own claim reference, echoed back; null until it is filed."},"itemCount":{"type":"integer","minimum":0,"description":"Items of the claim request."},"submittedCount":{"type":"integer","minimum":0,"description":"Items delivered so far."},"correctionCount":{"type":"integer","minimum":0,"description":"Items the firm sent back for correction."},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"First/last submit time of the claim; null when none."}},"required":["status","reference","itemCount","submittedCount","correctionCount","submittedAt"],"additionalProperties":false,"description":"Own receipt and guest-safe status of a creditor claim (WF04); present on insolvency creditor requests, absent elsewhere. Never carries another creditor data."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number"],"description":"Request item as the client sees it."}},"id":{"type":"string","format":"uuid","description":"Request id (addresses the item actions of the workspace)."},"sentAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["title","message","status","dueDate","recipientName","parties","joint","periodContext","firm","submittedAt","expiresAt","coverInstructions","displayStatus","progress","sections","items","id","sentAt"],"description":"A document request in the client workspace."}}}},"401":{"description":"Sign in with the e-mail code first: UNAUTHENTICATED without a session, EMAIL_CODE_REQUIRED with a session of another identity or a firm user.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown, expired or revoked link, or a request or item that is not this client’s.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"ITEM_NOT_OPEN.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/client-workspace/{token}/requests/{flowId}/items/{itemId}/questions":{"post":{"operationId":"askClientWorkspaceQuestion","summary":"Ask the firm a question about an item from the workspace","description":"Same as askPortalQuestion. Requires flow_item.respond. Writes message.posted (ids only).","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Link token from the request e-mail. Never a credential on its own."},"required":true,"description":"Link token from the request e-mail. Never a credential on its own.","name":"token","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":4000}},"required":["body"],"additionalProperties":false,"description":"One message on the item question thread."}}}},"responses":{"201":{"description":"Updated request.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipientName":{"type":"string"},"applicantSlot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"The applicant slot this guest link is bound to (M2/HYP-03). Absent on a legacy single-recipient link, where the guest may fill every slot; present on a shared request, where the view carries only this slot’s private files and answers."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."}},"required":["slot","label"],"additionalProperties":false},"description":"Named room parties of this request (WF01): slot and display label only, so a party learns no internal group id. Empty on legacy rows."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): this portal shares every bound slot’s drafts. False keeps the slot-private view."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance (ids and period keys only). Null on legacy rows without a period."},"firm":{"type":"object","properties":{"name":{"type":"string"},"initials":{"type":"string","maxLength":4},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Vertical of the firm that owns the request (ADR-0030); drives the mortgage upload notices."},"logoUrl":{"type":"string","maxLength":300,"description":"Same-origin URL of the firm logo (public branding asset), when the firm set one."}},"required":["name","initials"]},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"claimReceipt":{"type":"object","properties":{"status":{"type":"string","enum":["not_submitted","received","correction_requested","under_review"],"description":"Guest-safe creditor claim status (WF04); never an internal acceptance or ranking."},"reference":{"type":"string","nullable":true,"maxLength":100,"description":"The creditor's own claim reference, echoed back; null until it is filed."},"itemCount":{"type":"integer","minimum":0,"description":"Items of the claim request."},"submittedCount":{"type":"integer","minimum":0,"description":"Items delivered so far."},"correctionCount":{"type":"integer","minimum":0,"description":"Items the firm sent back for correction."},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"First/last submit time of the claim; null when none."}},"required":["status","reference","itemCount","submittedCount","correctionCount","submittedAt"],"additionalProperties":false,"description":"Own receipt and guest-safe status of a creditor claim (WF04); present on insolvency creditor requests, absent elsewhere. Never carries another creditor data."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number"],"description":"Request item as the client sees it."}},"id":{"type":"string","format":"uuid","description":"Request id (addresses the item actions of the workspace)."},"sentAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["title","message","status","dueDate","recipientName","parties","joint","periodContext","firm","submittedAt","expiresAt","coverInstructions","displayStatus","progress","sections","items","id","sentAt"],"description":"A document request in the client workspace."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Sign in with the e-mail code first: UNAUTHENTICATED without a session, EMAIL_CODE_REQUIRED with a session of another identity or a firm user.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown, expired or revoked link, or a request or item that is not this client’s.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/client-workspace/{token}/requests/{flowId}/submit":{"post":{"operationId":"submitClientWorkspaceRequest","summary":"Send the prepared items of a request from the workspace","description":"Same as submitPortalRequest: sends every open item with draft files or a draft not-applicable claim. Requires flow_item.submit or flow_item.respond per item; writes flow_item.submitted per item with the session strength. 409 NOTHING_TO_SUBMIT when nothing is prepared.","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Link token from the request e-mail. Never a credential on its own."},"required":true,"description":"Link token from the request e-mail. Never a credential on its own.","name":"token","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"}],"responses":{"200":{"description":"Updated request with the number of items sent.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipientName":{"type":"string"},"applicantSlot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"The applicant slot this guest link is bound to (M2/HYP-03). Absent on a legacy single-recipient link, where the guest may fill every slot; present on a shared request, where the view carries only this slot’s private files and answers."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."}},"required":["slot","label"],"additionalProperties":false},"description":"Named room parties of this request (WF01): slot and display label only, so a party learns no internal group id. Empty on legacy rows."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): this portal shares every bound slot’s drafts. False keeps the slot-private view."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance (ids and period keys only). Null on legacy rows without a period."},"firm":{"type":"object","properties":{"name":{"type":"string"},"initials":{"type":"string","maxLength":4},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Vertical of the firm that owns the request (ADR-0030); drives the mortgage upload notices."},"logoUrl":{"type":"string","maxLength":300,"description":"Same-origin URL of the firm logo (public branding asset), when the firm set one."}},"required":["name","initials"]},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"claimReceipt":{"type":"object","properties":{"status":{"type":"string","enum":["not_submitted","received","correction_requested","under_review"],"description":"Guest-safe creditor claim status (WF04); never an internal acceptance or ranking."},"reference":{"type":"string","nullable":true,"maxLength":100,"description":"The creditor's own claim reference, echoed back; null until it is filed."},"itemCount":{"type":"integer","minimum":0,"description":"Items of the claim request."},"submittedCount":{"type":"integer","minimum":0,"description":"Items delivered so far."},"correctionCount":{"type":"integer","minimum":0,"description":"Items the firm sent back for correction."},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"First/last submit time of the claim; null when none."}},"required":["status","reference","itemCount","submittedCount","correctionCount","submittedAt"],"additionalProperties":false,"description":"Own receipt and guest-safe status of a creditor claim (WF04); present on insolvency creditor requests, absent elsewhere. Never carries another creditor data."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number"],"description":"Request item as the client sees it."}},"id":{"type":"string","format":"uuid","description":"Request id (addresses the item actions of the workspace)."},"sentAt":{"type":"string","nullable":true,"format":"date-time"},"submittedCount":{"type":"integer","minimum":1}},"required":["title","message","status","dueDate","recipientName","parties","joint","periodContext","firm","submittedAt","expiresAt","coverInstructions","displayStatus","progress","sections","items","id","sentAt","submittedCount"],"description":"Workspace request after sending, with the number of items sent."}}}},"401":{"description":"Sign in with the e-mail code first: UNAUTHENTICATED without a session, EMAIL_CODE_REQUIRED with a session of another identity or a firm user.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown, expired or revoked link, or a request or item that is not this client’s.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"NOTHING_TO_SUBMIT.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/guest-sign-in/code":{"post":{"operationId":"requestGuestSignInCode","summary":"Send a guest sign-in code to an invited address","description":"Public (ADR-0003 D6, ADR-0042). Always answers the same 202 body and sets a fresh pre-authentication cookie, whether or not the address belongs to a guest, so it is no existence oracle (\"If this address has access, we sent a code\"). A code is queued only for an existing guest identity with at least one active guest principal, that is not locked and is within the per-identity code budget (3 per 15 minutes, 10 per 24 hours, shared with the invitation-link codes): 6 digits, 10 minutes, single use, 5 wrong attempts. The address is never echoed, logged or stored by this call. Per-IP rate limit (auth bucket). Writes auth.guest_code_sent (platform chain) when a code is queued.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"format":"email","description":"The address the firm invited. Never echoed, logged or stored by this call."}},"required":["email"],"additionalProperties":false,"description":"Ask for a sign-in code on the general guest sign-in page."}}}},"responses":{"202":{"description":"Code queued, if the address has access (uniform answer).","content":{"application/json":{"schema":{"type":"object","properties":{"sent":{"type":"boolean","enum":[true],"description":"A code was queued to the invited address, if the link is valid."}},"required":["sent"],"description":"Uniform answer of the \"send me a code\" endpoint (no existence oracle)."}}}},"400":{"description":"Invalid body (not an e-mail address).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Code sign-in is off (no database or no code pepper).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/guest-sign-in/session":{"post":{"operationId":"signInWithGuestEmailCode","summary":"Sign in a guest with the code from the general sign-in page","description":"Public (ADR-0003 D6, ADR-0042). Verifies the code of the challenge referenced by the pre-authentication cookie in constant time; a code requested through an invitation link is not accepted here. On success it starts a guest session (`subject_kind guest_email`, strength `single`, `amr [\"email_code\"]`) when the identity still has an active guest principal; the guest continues to its own rooms (`GET /api/v1/me`, `listMyRooms`). After 15 wrong codes for one identity within 24 hours code sign-in is locked for 60 minutes and a notice without a code is e-mailed; the lock answers the same 401 as any other failure. Writes auth.guest_code_verified (tenant chain) or auth.guest_code_failed (platform chain).","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","pattern":"^\\d{6}$","description":"6-digit e-mail code; single use and short lived (ADR-0003 D6)."}},"required":["code"],"additionalProperties":false,"description":"Sign in with the e-mail code from the general guest sign-in page."}}}},"responses":{"200":{"description":"Guest session created.","content":{"application/json":{"schema":{"type":"object","properties":{"authStrength":{"type":"string","enum":["single"],"description":"An e-mail code session is always `single` (ADR-0003 D7)."},"idleTimeoutSeconds":{"type":"integer","minimum":60,"description":"Idle timeout of the guest session."},"absoluteExpiresAt":{"type":"string","format":"date-time","description":"Absolute session expiry (UTC, ISO-8601)."}},"required":["authStrength","idleTimeoutSeconds","absoluteExpiresAt"],"description":"Guest session created on the general guest sign-in page."}}}},"400":{"description":"Invalid body (not a 6-digit code).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Wrong, reused or expired code, too many attempts, or locked (uniform answer).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Code sign-in is off (no database or no code pepper).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/compliance-packs":{"post":{"operationId":"createCompliancePack","summary":"Ask for a \"Deken-ready\" compliance pack","description":"Queues a ZIP with, per room, the access summary of the audit trail for the period and the chain proof, the retention and legal-hold status per room, the deletion certificates, the subprocessor list, an ISO 27001 SoA summary and a PDF cover (AUD-07, ADR-0045). audit.export.download on the tenant (firm_admin or compliance, step-up). The worker encrypts the file with the tenant key; it expires after 7 days and writes export.created (export_kind compliance_pack).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"string","format":"date","description":"First day of the period (inclusive, Europe/Amsterdam calendar day)."},"to":{"type":"string","format":"date","description":"Last day of the period (inclusive); not before `from`, at most 366 days."},"locale":{"type":"string","enum":["nl","en"],"default":"nl","description":"Language of the cover and headings."}},"required":["from","to"],"additionalProperties":false,"description":"Ask for a compliance pack over a period."}}}},"responses":{"202":{"description":"Queued.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Pack id."},"status":{"type":"string","enum":["queued","building","ready","failed"],"description":"Build state of the pack."},"periodFrom":{"type":"string","format":"date"},"periodTo":{"type":"string","format":"date"},"locale":{"type":"string","enum":["nl","en"],"description":"Language of the cover and headings."},"roomCount":{"type":"integer","nullable":true,"minimum":0,"description":"Rooms in the pack once built."},"eventCount":{"type":"integer","nullable":true,"minimum":0,"description":"Audit events of the period once built."},"chainStatus":{"type":"string","nullable":true,"enum":["verified","failed",null],"description":"Result of the audit hash-chain verification at build time."},"chainHeadSeq":{"type":"integer","nullable":true,"minimum":0,"description":"Verified chain head sequence number."},"chainHeadHash":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"Verified chain head hash (hex): the integrity proof printed in the pack."},"sizeBytes":{"type":"integer","nullable":true,"minimum":0},"sha256":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the ZIP (hex), verified again on download."},"failureCode":{"type":"string","nullable":true,"pattern":"^[A-Z][A-Z0-9_]{0,62}$"},"createdAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","format":"date-time","description":"When the file stops being downloadable."},"downloadable":{"type":"boolean","description":"Ready and not expired."}},"required":["id","status","periodFrom","periodTo","locale","roomCount","eventCount","chainStatus","chainHeadSeq","chainHeadHash","sizeBytes","sha256","failureCode","createdAt","completedAt","expiresAt","downloadable"],"description":"One compliance pack (ids, dates, counts and hashes only)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Not a firm admin or compliance officer, or step-up required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"RATE_LIMITED (too many packs in progress).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"The queue is unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"get":{"operationId":"listCompliancePacks","summary":"List the recent compliance packs of the firm","description":"The newest packs of the tenant with a keyset cursor (ids, dates, counts, hashes); `truncated` is true when the cap holds more packs than were returned, so a capped list is never mistaken for the whole list. retention.overview.read (firm_admin or compliance). Navigation read: no audit event.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","maxLength":512,"description":"Opaque keyset cursor from the previous page; omit it for the newest page."},"required":false,"description":"Opaque keyset cursor from the previous page; omit it for the newest page.","name":"cursor","in":"query"}],"responses":{"200":{"description":"Packs with an explicit partial signal.","content":{"application/json":{"schema":{"type":"object","properties":{"packs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Pack id."},"status":{"type":"string","enum":["queued","building","ready","failed"],"description":"Build state of the pack."},"periodFrom":{"type":"string","format":"date"},"periodTo":{"type":"string","format":"date"},"locale":{"type":"string","enum":["nl","en"],"description":"Language of the cover and headings."},"roomCount":{"type":"integer","nullable":true,"minimum":0,"description":"Rooms in the pack once built."},"eventCount":{"type":"integer","nullable":true,"minimum":0,"description":"Audit events of the period once built."},"chainStatus":{"type":"string","nullable":true,"enum":["verified","failed",null],"description":"Result of the audit hash-chain verification at build time."},"chainHeadSeq":{"type":"integer","nullable":true,"minimum":0,"description":"Verified chain head sequence number."},"chainHeadHash":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"Verified chain head hash (hex): the integrity proof printed in the pack."},"sizeBytes":{"type":"integer","nullable":true,"minimum":0},"sha256":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the ZIP (hex), verified again on download."},"failureCode":{"type":"string","nullable":true,"pattern":"^[A-Z][A-Z0-9_]{0,62}$"},"createdAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","format":"date-time","description":"When the file stops being downloadable."},"downloadable":{"type":"boolean","description":"Ready and not expired."}},"required":["id","status","periodFrom","periodTo","locale","roomCount","eventCount","chainStatus","chainHeadSeq","chainHeadHash","sizeBytes","sha256","failureCode","createdAt","completedAt","expiresAt","downloadable"],"description":"One compliance pack (ids, dates, counts and hashes only)."},"description":"Newest first."},"truncated":{"type":"boolean","default":false,"description":"True when more compliance packs exist than were returned (the list is partial). The server always sends an explicit value; the default keeps older bare payloads parseable as complete."},"nextCursor":{"type":"string","nullable":true,"default":null,"description":"Opaque cursor for the next (older) page; null on the last page."}},"required":["packs"],"description":"The firm’s recent compliance packs, newest first with an explicit partial signal."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Not a firm admin or compliance officer.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/compliance-packs/{packId}":{"get":{"operationId":"getCompliancePack","summary":"Read one compliance pack","description":"Build status of one pack. retention.overview.read. No audit event.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Pack id."},"required":true,"description":"Pack id.","name":"packId","in":"path"}],"responses":{"200":{"description":"Pack.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Pack id."},"status":{"type":"string","enum":["queued","building","ready","failed"],"description":"Build state of the pack."},"periodFrom":{"type":"string","format":"date"},"periodTo":{"type":"string","format":"date"},"locale":{"type":"string","enum":["nl","en"],"description":"Language of the cover and headings."},"roomCount":{"type":"integer","nullable":true,"minimum":0,"description":"Rooms in the pack once built."},"eventCount":{"type":"integer","nullable":true,"minimum":0,"description":"Audit events of the period once built."},"chainStatus":{"type":"string","nullable":true,"enum":["verified","failed",null],"description":"Result of the audit hash-chain verification at build time."},"chainHeadSeq":{"type":"integer","nullable":true,"minimum":0,"description":"Verified chain head sequence number."},"chainHeadHash":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"Verified chain head hash (hex): the integrity proof printed in the pack."},"sizeBytes":{"type":"integer","nullable":true,"minimum":0},"sha256":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"SHA-256 of the ZIP (hex), verified again on download."},"failureCode":{"type":"string","nullable":true,"pattern":"^[A-Z][A-Z0-9_]{0,62}$"},"createdAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","format":"date-time","description":"When the file stops being downloadable."},"downloadable":{"type":"boolean","description":"Ready and not expired."}},"required":["id","status","periodFrom","periodTo","locale","roomCount","eventCount","chainStatus","chainHeadSeq","chainHeadHash","sizeBytes","sha256","failureCode","createdAt","completedAt","expiresAt","downloadable"],"description":"One compliance pack (ids, dates, counts and hashes only)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Not a firm admin or compliance officer.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown pack (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/compliance-packs/{packId}/download":{"get":{"operationId":"downloadCompliancePack","summary":"Download a compliance pack (ZIP)","description":"Decrypts the ZIP, verifies its SHA-256 while streaming and writes export.downloaded before the first byte (fail closed with 503). audit.export.download (firm_admin or compliance, step-up), re-checked on every request.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Pack id."},"required":true,"description":"Pack id.","name":"packId","in":"path"}],"responses":{"200":{"description":"ZIP (application/zip)."},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Not a firm admin or compliance officer, or step-up required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown pack (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"DOWNLOAD_NOT_READY.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"410":{"description":"DOWNLOAD_EXPIRED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"AUDIT_UNAVAILABLE.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/portal/requests/{token}/items/{itemId}/files/{fileId}/receipt":{"get":{"operationId":"downloadPortalFileReceipt","summary":"Download the upload receipt of an own portal file (PDF)","description":"Proof of receipt for a file the signed-in guest uploaded through the client portal (AUD-09, ADR-0045 D2): timestamp, SHA-256 of the original, the audit event id of the upload and ids only. flow_item.read on the item and the guest must be the uploader. Writes receipt.downloaded.","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Link token from the request e-mail. Never a credential on its own."},"required":true,"description":"Link token from the request e-mail. Never a credential on its own.","name":"token","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"fileId","in":"path"}],"responses":{"200":{"description":"PDF receipt (application/pdf)."},"401":{"description":"Sign in with the e-mail code first.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown link, item or file, or not the uploader.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/exhibit-register/parties/{partyId}/submit":{"post":{"operationId":"submitRegisterParty","summary":"Mark the exhibit set of a party as submitted (ingediend)","description":"Stamps submittedAt on every exhibit of the party that is not yet submitted (ADR-0045 D3). Submitted numbers are locked: renumber, withdraw and remove answer 409 EXHIBIT_SUBMITTED. procedural_document.submit on the room. Writes exhibit_set.submitted (ids and counts only).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Party id of a procedure."},"required":true,"description":"Party id of a procedure.","name":"partyId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"expectedRevision":{"type":"integer","minimum":1,"description":"Revision the caller last saw; a mismatch answers 409 REVISION_CONFLICT."}},"additionalProperties":false,"description":"Mark the exhibit set of a party as submitted (ingediend); locks its numbers."}}}},"responses":{"200":{"description":"Register after the mutation.","content":{"application/json":{"schema":{"type":"object","properties":{"procedure":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid","description":"Procedure id."},"roomId":{"type":"string","format":"uuid","description":"Litigation room the procedure belongs to."},"title":{"type":"string","minLength":1,"maxLength":300,"description":"Case title, e.g. \"Jansen / Pietersen\" (client data)."},"court":{"type":"string","minLength":1,"maxLength":200,"description":"Court name (free text in the MVP)."},"instance":{"type":"string","enum":["first_instance","appeal"],"description":"Instance of the procedure: first instance (rechtbank) or appeal (gerechtshof)."},"caseType":{"type":"string","enum":["summons","application"],"description":"Case type: summons (dagvaarding, incl. kort geding) or application (verzoekschrift)."},"caseNumber":{"type":"string","nullable":true,"maxLength":100,"description":"Zaaknummer / rolnummer; often unknown before filing."},"continuesFromProcedureId":{"type":"string","nullable":true,"format":"uuid","description":"First-instance procedure this appeal continues; title is shown only with current access."},"status":{"type":"string","enum":["active","closed"],"description":"Procedure status; closed is read-only."},"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp (UTC, ISO-8601)."},"closedAt":{"type":"string","nullable":true,"format":"date-time","description":"Close timestamp, or null while active."},"parties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Party id of a procedure."},"procedureId":{"type":"string","format":"uuid","description":"Procedure id."},"role":{"type":"string","enum":["claimant","defendant","applicant","respondent","interested_party","appellant","respondent_on_appeal","intervener","joined_party"],"description":"Role of a party in the procedure."},"displayName":{"type":"string","minLength":1,"maxLength":200,"description":"Full party name as used in the index header (client data)."},"shortName":{"type":"string","minLength":1,"maxLength":40,"description":"Sanitised short name (unique per procedure, case-insensitive)."},"representedByFirm":{"type":"boolean","description":"Default filter in the UI; bundles for other parties are allowed."},"numberingOffset":{"type":"integer","minimum":0,"description":"Appeal continue-numbering offset (0 = start at 1)."},"sortOrder":{"type":"integer","description":"Display order among the procedure parties."},"createdAt":{"type":"string","format":"date-time"}},"required":["id","procedureId","role","displayName","shortName","representedByFirm","numberingOffset","sortOrder","createdAt"],"description":"One party in a procedure."}},"proceduralDocuments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Procedural document id (processtuk)."},"procedureId":{"type":"string","format":"uuid","description":"Procedure id."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"kind":{"type":"string","enum":["summons","statement_of_defence","reply","rejoinder","counterclaim_reply","deed_of_production","deed_of_response","deed_other","hearing_documents","interlocutory_motion","application","statement_of_response","statement_of_appeal","statement_of_response_on_appeal","other"],"description":"Kind of procedural document (processtuk)."},"title":{"type":"string","nullable":true,"maxLength":300,"description":"Custom label; defaults to the NL label of `kind`."},"sequence":{"type":"integer","minimum":0,"description":"Order within the procedure (submitted before drafts)."},"status":{"type":"string","enum":["draft","submitted"],"description":"Procedural document status: only drafts can be reordered or edited."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Optional link to the processtuk in the room index; null after a hard delete of the source and omitted entirely when the caller cannot view it (spec §7)."},"filedOn":{"type":"string","nullable":true,"format":"date","description":"Date the user entered when marking as submitted."},"submittedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","procedureId","partyId","kind","title","sequence","status","filedOn","submittedAt"],"description":"One procedural document (processtuk)."}}},"required":["id","roomId","title","court","instance","caseType","caseNumber","continuesFromProcedureId","status","revision","createdAt","closedAt","parties","proceduralDocuments"],"description":"The newest active procedure of the room, null when none is set up yet."},"exhibits":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"number":{"type":"integer","minimum":1,"maximum":99999},"status":{"type":"string","enum":["active","withdrawn","non_digital"],"description":"Exhibit status; withdrawn keeps its number and slot."},"redacted":{"type":"boolean","enum":[false]},"description":{"type":"string","nullable":true,"maxLength":300,"description":"Default = document title (client data)."},"descriptionIsDefault":{"type":"boolean"},"documentDate":{"type":"string","nullable":true,"format":"date","description":"Shown as \"z.d.\" when empty."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Source document; null after a hard delete."},"documentVersionId":{"type":"string","nullable":true,"format":"uuid","description":"Pinned version (spec §4.7)."},"nodeId":{"type":"string","nullable":true,"format":"uuid","description":"Index node of the source document (links to the viewer)."},"sourceTitle":{"type":"string","nullable":true,"maxLength":500,"description":"Current index title of the source (client data)."},"fileName":{"type":"string","nullable":true,"maxLength":100,"pattern":"^(?<short>[A-Za-z0-9][A-Za-z0-9 ._-]{0,39}) productie (?<n>[1-9][0-9]{0,4})( deel (?<k>[1-9][0-9]?) van (?<m>[1-9][0-9]?))?\\.pdf$","description":"Generated court file name (`{short} productie {n}.pdf`), null when not derivable."},"withdrawnReasonCode":{"type":"string","nullable":true,"enum":["not_relied_on","replaced","filed_in_error","other",null],"description":"Withdrawal reason code."},"newerVersionAvailable":{"type":"boolean","description":"A newer source version with another blob exists."},"sourceInTrash":{"type":"boolean"},"internalSource":{"type":"boolean","description":"The source sits in an internal counsel area (PR-W05)."},"createdAt":{"type":"string","format":"date-time"},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the exhibit set of its party was marked submitted (ADR-0045); the number is then locked."}},"required":["id","partyId","number","status","redacted","description","descriptionIsDefault","documentDate","documentId","documentVersionId","nodeId","sourceTitle","fileName","withdrawnReasonCode","newerVersionAvailable","sourceInTrash","internalSource","createdAt","submittedAt"],"description":"Exhibit of the room register (full row)."},{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Exhibit id (productie)."},"partyId":{"type":"string","format":"uuid","description":"Party id of a procedure."},"number":{"type":"integer","minimum":1,"maximum":99999},"status":{"type":"string","enum":["active","withdrawn","non_digital"],"description":"Exhibit status; withdrawn keeps its number and slot."},"redacted":{"type":"boolean","enum":[true]},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the exhibit set of its party was marked submitted (ADR-0045); the number is then locked."}},"required":["id","partyId","number","status","redacted","submittedAt"],"additionalProperties":false,"description":"Redacted register row: number and status only."}],"description":"Register row: full for viewable sources, redacted otherwise."},"description":"Exhibits of every party of the procedure, ordered by party then number."},"canManage":{"type":"boolean","description":"The caller may add, withdraw, remove and renumber exhibits."},"canSetUp":{"type":"boolean","description":"The caller may create or edit the procedure and its parties."},"revision":{"type":"integer","minimum":1,"description":"Content revision of the procedure; required for number/order-changing mutations."}},"required":["procedure","exhibits","canManage","canSetUp","revision"],"description":"Register after the mutation, with the procedure revision it produced."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no exhibit.manage, or no view on the source).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, party, exhibit or document, or no access (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"READ_ONLY, REVISION_CONFLICT or NOTHING_TO_SUBMIT (no unsubmitted exhibit).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/qa/categories":{"post":{"operationId":"createRoomQaCategory","summary":"Add a room-specific question category","description":"qa.manage on the room. A name and a colour, unique per room. Writes `qa_category.changed` (ids and a code only). Every member reads the categories on the overview.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60},"colour":{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Colour as lowercase `#rrggbb`."},"sortOrder":{"type":"integer","minimum":0,"maximum":10000}},"required":["name","colour"],"additionalProperties":false,"description":"Add a category to the room (coordinator)."}}}},"responses":{"201":{"description":"The overview with the categories.","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"role":{"type":"string","enum":["coordinator","expert","observer","bidder"],"description":"coordinator = qa.manage, expert = qa.answer, observer = internal read only, bidder = guest of an external group."},"counts":{"type":"object","properties":{"open":{"type":"integer","minimum":0},"in_progress":{"type":"integer","minimum":0},"answered":{"type":"integer","minimum":0},"published":{"type":"integer","minimum":0},"rejected":{"type":"integer","minimum":0},"closed":{"type":"integer","minimum":0},"overdue":{"type":"integer","minimum":0,"description":"Not yet published or closed and past the due date."}},"required":["open","in_progress","answered","published","rejected","closed","overdue"],"additionalProperties":false,"description":"Question counts per status among the questions the caller may read (QA-09)."},"quota":{"type":"object","nullable":true,"properties":{"groupId":{"type":"string","format":"uuid"},"groupName":{"type":"string","nullable":true},"limit":{"type":"integer","nullable":true,"minimum":0,"description":"null = no limit."},"used":{"type":"integer","minimum":0}},"required":["groupId","groupName","limit","used"],"additionalProperties":false},"settings":{"type":"object","nullable":true,"properties":{"defaultQuestionLimit":{"type":"integer","nullable":true,"minimum":0},"notifyEmail":{"type":"string","nullable":true,"description":"The deal team's notification address (firm-controlled)."},"revision":{"type":"integer","minimum":1},"groups":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true,"description":"Group name as the firm entered it."},"kind":{"type":"string","enum":["client","counterparty","expert","custom_external"]},"questionLimit":{"type":"integer","nullable":true,"minimum":0,"description":"Quota override; null = room default."},"asked":{"type":"integer","minimum":0,"description":"Questions asked by this group so far."}},"required":["groupId","name","kind","questionLimit","asked"],"additionalProperties":false,"description":"An external group of the room that may ask questions."}}},"required":["defaultQuestionLimit","notifyEmail","revision","groups"],"additionalProperties":false},"experts":{"type":"array","items":{"type":"object","properties":{"principalId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true,"description":"Display name, or null when none is set."}},"required":["principalId","name"],"additionalProperties":false,"description":"An internal member of the room who may draft answers."}},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":60},"colour":{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Colour as lowercase `#rrggbb`."},"sortOrder":{"type":"integer","minimum":0},"questionCount":{"type":"integer","minimum":0,"description":"Questions carrying this category (as the caller may read them)."}},"required":["id","name","colour","sortOrder","questionCount"],"additionalProperties":false,"description":"A room-specific question category."}}},"required":["enabled","role","counts","quota","settings","experts","categories"],"additionalProperties":false,"description":"Q&A overview of a room for the caller."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (the caller does not coordinate the Q&A, or the room is not active).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, question or category, Q&A not enabled, no access, a bidder (timeline), or cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"CONFLICT: a category with that name exists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/qa/categories/{categoryId}":{"patch":{"operationId":"updateRoomQaCategory","summary":"Rename, recolour or reorder a category","description":"qa.manage on the room. Writes `qa_category.changed`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Category id."},"required":true,"description":"Category id.","name":"categoryId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60},"colour":{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Colour as lowercase `#rrggbb`."},"sortOrder":{"type":"integer","minimum":0,"maximum":10000}},"additionalProperties":false,"description":"Rename or recolour a category (coordinator)."}}}},"responses":{"200":{"description":"The overview with the categories.","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"role":{"type":"string","enum":["coordinator","expert","observer","bidder"],"description":"coordinator = qa.manage, expert = qa.answer, observer = internal read only, bidder = guest of an external group."},"counts":{"type":"object","properties":{"open":{"type":"integer","minimum":0},"in_progress":{"type":"integer","minimum":0},"answered":{"type":"integer","minimum":0},"published":{"type":"integer","minimum":0},"rejected":{"type":"integer","minimum":0},"closed":{"type":"integer","minimum":0},"overdue":{"type":"integer","minimum":0,"description":"Not yet published or closed and past the due date."}},"required":["open","in_progress","answered","published","rejected","closed","overdue"],"additionalProperties":false,"description":"Question counts per status among the questions the caller may read (QA-09)."},"quota":{"type":"object","nullable":true,"properties":{"groupId":{"type":"string","format":"uuid"},"groupName":{"type":"string","nullable":true},"limit":{"type":"integer","nullable":true,"minimum":0,"description":"null = no limit."},"used":{"type":"integer","minimum":0}},"required":["groupId","groupName","limit","used"],"additionalProperties":false},"settings":{"type":"object","nullable":true,"properties":{"defaultQuestionLimit":{"type":"integer","nullable":true,"minimum":0},"notifyEmail":{"type":"string","nullable":true,"description":"The deal team's notification address (firm-controlled)."},"revision":{"type":"integer","minimum":1},"groups":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true,"description":"Group name as the firm entered it."},"kind":{"type":"string","enum":["client","counterparty","expert","custom_external"]},"questionLimit":{"type":"integer","nullable":true,"minimum":0,"description":"Quota override; null = room default."},"asked":{"type":"integer","minimum":0,"description":"Questions asked by this group so far."}},"required":["groupId","name","kind","questionLimit","asked"],"additionalProperties":false,"description":"An external group of the room that may ask questions."}}},"required":["defaultQuestionLimit","notifyEmail","revision","groups"],"additionalProperties":false},"experts":{"type":"array","items":{"type":"object","properties":{"principalId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true,"description":"Display name, or null when none is set."}},"required":["principalId","name"],"additionalProperties":false,"description":"An internal member of the room who may draft answers."}},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":60},"colour":{"type":"string","pattern":"^#[0-9a-f]{6}$","description":"Colour as lowercase `#rrggbb`."},"sortOrder":{"type":"integer","minimum":0},"questionCount":{"type":"integer","minimum":0,"description":"Questions carrying this category (as the caller may read them)."}},"required":["id","name","colour","sortOrder","questionCount"],"additionalProperties":false,"description":"A room-specific question category."}}},"required":["enabled","role","counts","quota","settings","experts","categories"],"additionalProperties":false,"description":"Q&A overview of a room for the caller."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (the caller does not coordinate the Q&A, or the room is not active).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, question or category, Q&A not enabled, no access, a bidder (timeline), or cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"CONFLICT: a category with that name exists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/qa/questions/{questionId}/reassign":{"post":{"operationId":"reassignRoomQaQuestion","summary":"Reassign a question to another expert with a hand-over note","description":"qa.manage on the room. Routes the question to the expert and posts the note as an internal note (never visible to bidders). Not allowed on a published, rejected or closed question. Writes `qa_question.updated` (field `assignee`, the assignee id) and `qa_note.posted`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Question id."},"required":true,"description":"Question id.","name":"questionId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"revision":{"type":"integer","minimum":1},"assigneeId":{"type":"string","format":"uuid","description":"The expert who takes the question over."},"note":{"type":"string","minLength":1,"maxLength":10000,"description":"Mandatory hand-over note, posted as an internal note (never to bidders)."}},"required":["revision","assigneeId","note"],"additionalProperties":false,"description":"Reassign a question to another expert with a note (QA-13)."}}}},"responses":{"200":{"description":"The question with its thread as the caller may read it.","content":{"application/json":{"schema":{"type":"object","properties":{"question":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"integer","nullable":true,"minimum":1,"description":"Number within the asking group; null for FAQ of another group."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Asking group; null for a bidder reading another group’s FAQ."},"groupName":{"type":"string","nullable":true},"ownGroup":{"type":"boolean","description":"The caller is a member of the asking group."},"subject":{"type":"string","nullable":true,"description":"Question subject (client data); null only after scrubbing."},"category":{"type":"string","enum":["general","legal","financial","tax","commercial","hr","it","real_estate","environmental","other"],"description":"Question category (due-diligence workstream)."},"categoryId":{"type":"string","nullable":true,"format":"uuid","description":"Room-specific category (QA-08); null when none."},"categoryName":{"type":"string","nullable":true},"categoryColour":{"type":"string","nullable":true,"pattern":"^#[0-9a-f]{6}$","description":"Colour as lowercase `#rrggbb`."},"priority":{"type":"string","enum":["low","normal","high"],"description":"Question priority."},"status":{"type":"string","enum":["open","in_progress","answered","published","rejected","closed"],"description":"open = new, in_progress = routed to an expert, answered = answer awaits approval, published = answer released, rejected = declined by the coordinator with a reason (QA-13), closed."},"faq":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date"},"overdue":{"type":"boolean"},"assigneeId":{"type":"string","nullable":true,"format":"uuid"},"assigneeName":{"type":"string","nullable":true},"nodeId":{"type":"string","nullable":true,"format":"uuid","description":"Linked document or folder; null when none or not shown."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Document of the linked node (opens the viewer); null for a folder or when not shown."},"pageNo":{"type":"integer","nullable":true,"minimum":1},"answerState":{"type":"string","enum":["none","draft","submitted","approved","rejected"],"description":"State of the latest answer of a question (bidders only ever see none or approved)."},"askedAt":{"type":"string","format":"date-time"},"publishedAt":{"type":"string","nullable":true,"format":"date-time"},"revision":{"type":"integer","minimum":1}},"required":["id","number","groupId","groupName","ownGroup","subject","category","categoryId","categoryName","categoryColour","priority","status","faq","dueDate","overdue","assigneeId","assigneeName","nodeId","documentId","pageNo","answerState","askedAt","publishedAt","revision"],"additionalProperties":false,"description":"A Q&A question as listed for the caller."},"body":{"type":"string","nullable":true,"description":"Question text (client data)."},"askedByName":{"type":"string","nullable":true,"description":"Internal readers and the asking group only."},"linkTitle":{"type":"string","nullable":true,"description":"Title of the linked node when the caller may read it (node.read); otherwise null."},"onBehalf":{"type":"boolean","description":"Recorded by the coordinator for the group (e.g. received by e-mail)."},"rejectionReason":{"type":"string","nullable":true,"description":"Why the coordinator declined the question (QA-13); the asking group reads it too."},"entries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["answer","note"]},"state":{"type":"string","enum":["draft","submitted","approved","rejected","posted"]},"body":{"type":"string","nullable":true,"description":"Answer or note text (client data)."},"authorId":{"type":"string","nullable":true,"format":"uuid","description":"Null for bidders."},"authorName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"decidedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","kind","state","body","authorId","authorName","createdAt","updatedAt","decidedAt"],"additionalProperties":false,"description":"One entry of a question thread. Bidders only receive approved answers."}},"can":{"type":"object","properties":{"answer":{"type":"boolean"},"manage":{"type":"boolean"},"publish":{"type":"boolean","description":"A submitted answer awaits approval and the caller coordinates."}},"required":["answer","manage","publish"],"additionalProperties":false}},"required":["question","body","askedByName","linkTitle","onBehalf","rejectionReason","entries","can"],"additionalProperties":false,"description":"A question with its thread, as the caller may read it."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (the caller does not coordinate the Q&A, or the room is not active).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, question or category, Q&A not enabled, no access, a bidder (timeline), or cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"CONFLICT: the question changed (revision), or its status does not allow this.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/qa/questions/{questionId}/decline":{"post":{"operationId":"declineRoomQaQuestion","summary":"Decline a question with a mandatory reason","description":"qa.manage on the room. The question moves to `rejected`; the asking group reads the reason on the question, other bidders never see the question. Reopen (PATCH status `reopened`) undoes it. Writes `qa_question.rejected` (the reason length only).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Question id."},"required":true,"description":"Question id.","name":"questionId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"revision":{"type":"integer","minimum":1},"reason":{"type":"string","minLength":1,"maxLength":2000,"description":"Mandatory reason; the asking group reads it (client data, never audited)."}},"required":["revision","reason"],"additionalProperties":false,"description":"Decline a question with a reason (QA-13). The question moves to `rejected`; reopen undoes it."}}}},"responses":{"200":{"description":"The question with its thread as the caller may read it.","content":{"application/json":{"schema":{"type":"object","properties":{"question":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"integer","nullable":true,"minimum":1,"description":"Number within the asking group; null for FAQ of another group."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Asking group; null for a bidder reading another group’s FAQ."},"groupName":{"type":"string","nullable":true},"ownGroup":{"type":"boolean","description":"The caller is a member of the asking group."},"subject":{"type":"string","nullable":true,"description":"Question subject (client data); null only after scrubbing."},"category":{"type":"string","enum":["general","legal","financial","tax","commercial","hr","it","real_estate","environmental","other"],"description":"Question category (due-diligence workstream)."},"categoryId":{"type":"string","nullable":true,"format":"uuid","description":"Room-specific category (QA-08); null when none."},"categoryName":{"type":"string","nullable":true},"categoryColour":{"type":"string","nullable":true,"pattern":"^#[0-9a-f]{6}$","description":"Colour as lowercase `#rrggbb`."},"priority":{"type":"string","enum":["low","normal","high"],"description":"Question priority."},"status":{"type":"string","enum":["open","in_progress","answered","published","rejected","closed"],"description":"open = new, in_progress = routed to an expert, answered = answer awaits approval, published = answer released, rejected = declined by the coordinator with a reason (QA-13), closed."},"faq":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date"},"overdue":{"type":"boolean"},"assigneeId":{"type":"string","nullable":true,"format":"uuid"},"assigneeName":{"type":"string","nullable":true},"nodeId":{"type":"string","nullable":true,"format":"uuid","description":"Linked document or folder; null when none or not shown."},"documentId":{"type":"string","nullable":true,"format":"uuid","description":"Document of the linked node (opens the viewer); null for a folder or when not shown."},"pageNo":{"type":"integer","nullable":true,"minimum":1},"answerState":{"type":"string","enum":["none","draft","submitted","approved","rejected"],"description":"State of the latest answer of a question (bidders only ever see none or approved)."},"askedAt":{"type":"string","format":"date-time"},"publishedAt":{"type":"string","nullable":true,"format":"date-time"},"revision":{"type":"integer","minimum":1}},"required":["id","number","groupId","groupName","ownGroup","subject","category","categoryId","categoryName","categoryColour","priority","status","faq","dueDate","overdue","assigneeId","assigneeName","nodeId","documentId","pageNo","answerState","askedAt","publishedAt","revision"],"additionalProperties":false,"description":"A Q&A question as listed for the caller."},"body":{"type":"string","nullable":true,"description":"Question text (client data)."},"askedByName":{"type":"string","nullable":true,"description":"Internal readers and the asking group only."},"linkTitle":{"type":"string","nullable":true,"description":"Title of the linked node when the caller may read it (node.read); otherwise null."},"onBehalf":{"type":"boolean","description":"Recorded by the coordinator for the group (e.g. received by e-mail)."},"rejectionReason":{"type":"string","nullable":true,"description":"Why the coordinator declined the question (QA-13); the asking group reads it too."},"entries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["answer","note"]},"state":{"type":"string","enum":["draft","submitted","approved","rejected","posted"]},"body":{"type":"string","nullable":true,"description":"Answer or note text (client data)."},"authorId":{"type":"string","nullable":true,"format":"uuid","description":"Null for bidders."},"authorName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"decidedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","kind","state","body","authorId","authorName","createdAt","updatedAt","decidedAt"],"additionalProperties":false,"description":"One entry of a question thread. Bidders only receive approved answers."}},"can":{"type":"object","properties":{"answer":{"type":"boolean"},"manage":{"type":"boolean"},"publish":{"type":"boolean","description":"A submitted answer awaits approval and the caller coordinates."}},"required":["answer","manage","publish"],"additionalProperties":false}},"required":["question","body","askedByName","linkTitle","onBehalf","rejectionReason","entries","can"],"additionalProperties":false,"description":"A question with its thread, as the caller may read it."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (the caller does not coordinate the Q&A, or the room is not active).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, question or category, Q&A not enabled, no access, a bidder (timeline), or cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"CONFLICT: the question changed (revision), or its status does not allow this.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/qa/questions/{questionId}/activity":{"get":{"operationId":"getRoomQaQuestionActivity","summary":"Activity timeline of a question","description":"qa.read on the room, internal readers only (coordinator, expert, observer); a bidder gets 404. Who asked, routed, reassigned, drafted, submitted, noted, sent back, published, declined, closed or reopened, and when. Codes, ids and display names only.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Question id."},"required":true,"description":"Question id.","name":"questionId","in":"path"}],"responses":{"200":{"description":"The timeline, oldest first.","content":{"application/json":{"schema":{"type":"object","properties":{"entries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["asked","routed","reassigned","unrouted","updated","drafted","submitted","note_posted","answer_rejected","published","declined","closed","reopened"],"description":"What happened to the question."},"actorId":{"type":"string","nullable":true,"format":"uuid"},"actorName":{"type":"string","nullable":true},"targetId":{"type":"string","nullable":true,"format":"uuid","description":"The expert routed to, for routing kinds."},"targetName":{"type":"string","nullable":true},"at":{"type":"string","format":"date-time"}},"required":["id","kind","actorId","actorName","targetId","targetName","at"],"additionalProperties":false,"description":"One step of a question timeline: codes, ids and names only."}}},"required":["entries"],"additionalProperties":false,"description":"The activity timeline of a question, oldest first (internal readers only)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, question or category, Q&A not enabled, no access, a bidder (timeline), or cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/findings":{"get":{"operationId":"listRoomFindings","summary":"The findings register of a room","description":"finding.read (`view`, firm users only) on the room. Newest first with a keyset cursor, with counts, the internal members who may own a finding and whether the caller may write; `truncated` is true when the cap holds more findings than were returned, so a capped register is never mistaken for the whole register. `overdue=true` narrows to open findings whose follow-up date has passed; each finding carries that date and a derived `overdue`, and the counts include an `overdue` total. A due date is reported, never enforced: nothing is blocked or closed by it. Guests always get 404: the register is internal to the deal team.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","enum":["open","mitigated","closed"],"description":"Status."},"required":false,"description":"Status.","name":"status","in":"query"},{"schema":{"type":"string","enum":["low","medium","high","critical"],"description":"Severity."},"required":false,"description":"Severity.","name":"severity","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"ownerId","in":"query"},{"schema":{"type":"string","enum":["true"],"description":"Only open findings whose due date has passed."},"required":false,"description":"Only open findings whose due date has passed.","name":"overdue","in":"query"},{"schema":{"type":"string","maxLength":512,"description":"Opaque keyset cursor from the previous page; omit it for the newest page."},"required":false,"description":"Opaque keyset cursor from the previous page; omit it for the newest page.","name":"cursor","in":"query"}],"responses":{"200":{"description":"The register with an explicit partial signal.","content":{"application/json":{"schema":{"type":"object","properties":{"findings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"integer","minimum":1,"description":"Number within the room."},"title":{"type":"string","nullable":true,"description":"Client data; null only after scrubbing."},"severity":{"type":"string","enum":["low","medium","high","critical"],"description":"Severity."},"category":{"type":"string","nullable":true},"status":{"type":"string","enum":["open","mitigated","closed"],"description":"Status."},"ownerId":{"type":"string","nullable":true,"format":"uuid"},"ownerName":{"type":"string","nullable":true},"dueDate":{"type":"string","nullable":true,"format":"date-time","default":null,"description":"When the owner is expected to have dealt with it, or null. Reported, never enforced: nothing is blocked or closed by it. The default keeps a payload from an older server parseable."},"overdue":{"type":"boolean","default":false,"description":"Derived at read time: a due date in the past while the finding is still open."},"notes":{"type":"string","nullable":true},"links":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["document","question"]},"id":{"type":"string","format":"uuid","description":"Document id or Q&A question id."},"pageNo":{"type":"integer","nullable":true,"minimum":1,"maximum":100000,"description":"Page, for a document link."},"title":{"type":"string","nullable":true,"description":"Document title or question subject when the caller may read it; else null."}},"required":["kind","id","pageNo","title"],"additionalProperties":false,"description":"A link with its resolved title."}},"createdById":{"type":"string","format":"uuid"},"createdByName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"revision":{"type":"integer","minimum":1}},"required":["id","number","title","severity","category","status","ownerId","ownerName","notes","links","createdById","createdByName","createdAt","updatedAt","revision"],"additionalProperties":false,"description":"One finding of the register."}},"counts":{"type":"object","properties":{"open":{"type":"integer","minimum":0},"mitigated":{"type":"integer","minimum":0},"closed":{"type":"integer","minimum":0},"critical":{"type":"integer","minimum":0,"description":"Open or mitigated findings of severity critical."},"high":{"type":"integer","minimum":0,"description":"Open or mitigated findings of severity high."},"overdue":{"type":"integer","minimum":0,"default":0,"description":"Open findings whose due date has passed. The default keeps a payload from an older server parseable."}},"required":["open","mitigated","closed","critical","high"],"additionalProperties":false,"description":"Counts over the register."},"members":{"type":"array","items":{"type":"object","properties":{"principalId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true}},"required":["principalId","name"],"additionalProperties":false,"description":"An internal member of the room who may own a finding."}},"canManage":{"type":"boolean","description":"The caller holds `finding.manage`."},"truncated":{"type":"boolean","default":false,"description":"True when more findings exist than were returned (the register is partial). The server always sends an explicit value; the default keeps older bare payloads parseable as complete."},"nextCursor":{"type":"string","nullable":true,"default":null,"description":"Opaque cursor for the next (older) page; null on the last page."}},"required":["findings","counts","members","canManage"],"additionalProperties":false,"description":"The findings register of a room, newest first with an explicit partial signal."}}}},"400":{"description":"Invalid query.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or finding, no access, a guest, a support session or cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"post":{"operationId":"createRoomFinding","summary":"Record a finding","description":"finding.manage (`edit`, firm users only) on the room. Links to documents must be live documents of the room the caller may read; links to questions must be questions of the room. Writes `finding.created` (ids and codes only).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":200},"severity":{"type":"string","enum":["low","medium","high","critical"],"description":"Severity."},"category":{"type":"string","nullable":true,"minLength":1,"maxLength":60},"status":{"type":"string","enum":["open","mitigated","closed"],"default":"open","description":"Status."},"ownerId":{"type":"string","nullable":true,"format":"uuid"},"dueDate":{"type":"string","nullable":true,"format":"date-time","description":"Follow-up date; absent or null means none."},"notes":{"type":"string","nullable":true,"minLength":1,"maxLength":10000},"links":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["document","question"]},"id":{"type":"string","format":"uuid","description":"Document id or Q&A question id."},"pageNo":{"type":"integer","nullable":true,"minimum":1,"maximum":100000,"description":"Page, for a document link."}},"required":["kind","id","pageNo"],"additionalProperties":false,"description":"A link from a finding to a document page or a question."},"maxItems":50,"default":[]}},"required":["title","severity","category","ownerId","notes"],"additionalProperties":false,"description":"Record a finding (QA-14)."}}}},"responses":{"201":{"description":"Recorded.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"integer","minimum":1,"description":"Number within the room."},"title":{"type":"string","nullable":true,"description":"Client data; null only after scrubbing."},"severity":{"type":"string","enum":["low","medium","high","critical"],"description":"Severity."},"category":{"type":"string","nullable":true},"status":{"type":"string","enum":["open","mitigated","closed"],"description":"Status."},"ownerId":{"type":"string","nullable":true,"format":"uuid"},"ownerName":{"type":"string","nullable":true},"dueDate":{"type":"string","nullable":true,"format":"date-time","default":null,"description":"When the owner is expected to have dealt with it, or null. Reported, never enforced: nothing is blocked or closed by it. The default keeps a payload from an older server parseable."},"overdue":{"type":"boolean","default":false,"description":"Derived at read time: a due date in the past while the finding is still open."},"notes":{"type":"string","nullable":true},"links":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["document","question"]},"id":{"type":"string","format":"uuid","description":"Document id or Q&A question id."},"pageNo":{"type":"integer","nullable":true,"minimum":1,"maximum":100000,"description":"Page, for a document link."},"title":{"type":"string","nullable":true,"description":"Document title or question subject when the caller may read it; else null."}},"required":["kind","id","pageNo","title"],"additionalProperties":false,"description":"A link with its resolved title."}},"createdById":{"type":"string","format":"uuid"},"createdByName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"revision":{"type":"integer","minimum":1}},"required":["id","number","title","severity","category","status","ownerId","ownerName","notes","links","createdById","createdByName","createdAt","updatedAt","revision"],"additionalProperties":false,"description":"One finding of the register."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"A room member without `edit` (finding.manage), or the room is not active.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or finding, no access, a guest, a support session or cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/findings/export":{"get":{"operationId":"exportRoomFindings","summary":"Export the register as XLSX","description":"finding.manage on the room. One row per finding (number, title, severity, category, status, owner, follow-up date, links, notes, dates), formula-safe. Writes `finding.exported` (count only) before the first byte (fail closed with 503).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","enum":["nl","en"]},"required":false,"name":"lang","in":"query"}],"responses":{"200":{"description":"The workbook.","headers":{"Content-Disposition":{"schema":{"type":"string","description":"`attachment` with a file name made of the date only."},"required":true,"description":"`attachment` with a file name made of the date only."},"Cache-Control":{"schema":{"type":"string","enum":["no-store"]},"required":true}},"content":{"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","description":"Binary XLSX."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"A room member without `edit` (finding.manage), or the room is not active.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or finding, no access, a guest, a support session or cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"The audit event could not be written; nothing was served.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/findings/{findingId}":{"patch":{"operationId":"updateRoomFinding","summary":"Change a finding","description":"finding.manage on the room. Optimistic concurrency through `revision` (409 CONFLICT). Writes `finding.updated` (the changed field codes, the status and severity codes).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Finding id."},"required":true,"description":"Finding id.","name":"findingId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"revision":{"type":"integer","minimum":1},"title":{"type":"string","minLength":1,"maxLength":200},"severity":{"type":"string","enum":["low","medium","high","critical"],"description":"Severity."},"category":{"type":"string","nullable":true,"minLength":1,"maxLength":60},"status":{"type":"string","enum":["open","mitigated","closed"],"description":"Status."},"ownerId":{"type":"string","nullable":true,"format":"uuid"},"dueDate":{"type":"string","nullable":true,"format":"date-time","description":"Follow-up date; null clears it."},"notes":{"type":"string","nullable":true,"minLength":1,"maxLength":10000},"links":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["document","question"]},"id":{"type":"string","format":"uuid","description":"Document id or Q&A question id."},"pageNo":{"type":"integer","nullable":true,"minimum":1,"maximum":100000,"description":"Page, for a document link."}},"required":["kind","id","pageNo"],"additionalProperties":false,"description":"A link from a finding to a document page or a question."},"maxItems":50}},"required":["revision"],"additionalProperties":false,"description":"Change a finding; every field is optional, the revision is mandatory."}}}},"responses":{"200":{"description":"The finding.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":"integer","minimum":1,"description":"Number within the room."},"title":{"type":"string","nullable":true,"description":"Client data; null only after scrubbing."},"severity":{"type":"string","enum":["low","medium","high","critical"],"description":"Severity."},"category":{"type":"string","nullable":true},"status":{"type":"string","enum":["open","mitigated","closed"],"description":"Status."},"ownerId":{"type":"string","nullable":true,"format":"uuid"},"ownerName":{"type":"string","nullable":true},"dueDate":{"type":"string","nullable":true,"format":"date-time","default":null,"description":"When the owner is expected to have dealt with it, or null. Reported, never enforced: nothing is blocked or closed by it. The default keeps a payload from an older server parseable."},"overdue":{"type":"boolean","default":false,"description":"Derived at read time: a due date in the past while the finding is still open."},"notes":{"type":"string","nullable":true},"links":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["document","question"]},"id":{"type":"string","format":"uuid","description":"Document id or Q&A question id."},"pageNo":{"type":"integer","nullable":true,"minimum":1,"maximum":100000,"description":"Page, for a document link."},"title":{"type":"string","nullable":true,"description":"Document title or question subject when the caller may read it; else null."}},"required":["kind","id","pageNo","title"],"additionalProperties":false,"description":"A link with its resolved title."}},"createdById":{"type":"string","format":"uuid"},"createdByName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"revision":{"type":"integer","minimum":1}},"required":["id","number","title","severity","category","status","ownerId","ownerName","notes","links","createdById","createdByName","createdAt","updatedAt","revision"],"additionalProperties":false,"description":"One finding of the register."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"A room member without `edit` (finding.manage), or the room is not active.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or finding, no access, a guest, a support session or cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"CONFLICT: the finding changed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/annotations":{"get":{"operationId":"listDocumentAnnotations","summary":"My notes and highlights on a document, plus the ones shared with the deal team","description":"document.annotate (`view`, firm users only) on the document node. Own annotations and shared ones of other firm users, by page. Guests never receive an annotation (404).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"},{"schema":{"type":"string","maxLength":512,"description":"Opaque keyset cursor from the previous page; omit it for the first page."},"required":false,"description":"Opaque keyset cursor from the previous page; omit it for the first page.","name":"cursor","in":"query"}],"responses":{"200":{"description":"The annotations.","content":{"application/json":{"schema":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"pageNo":{"type":"integer","minimum":1},"kind":{"type":"string","enum":["note","highlight"],"description":"note = text on a page (optionally with an area); highlight = a marked area (optionally with text)."},"rect":{"type":"object","nullable":true,"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"Left edge as a fraction of the page width."},"y":{"type":"number","minimum":0,"maximum":1,"description":"Top edge as a fraction of the page height."},"w":{"type":"number","minimum":0,"exclusiveMinimum":true,"maximum":1,"description":"Width as a fraction of the page width."},"h":{"type":"number","minimum":0,"exclusiveMinimum":true,"maximum":1,"description":"Height as a fraction of the page height."}},"required":["x","y","w","h"],"additionalProperties":false,"description":"A rectangle in page fractions (origin top left)."},"body":{"type":"string","nullable":true,"description":"Note text (client data)."},"authorId":{"type":"string","format":"uuid"},"authorName":{"type":"string","nullable":true},"own":{"type":"boolean","description":"The caller made it (and may remove it)."},"shared":{"type":"boolean","description":"Visible to the deal team of the room."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","documentId","pageNo","kind","rect","body","authorId","authorName","own","shared","createdAt","updatedAt"],"additionalProperties":false,"description":"A personal note or highlight on a document page."}},"truncated":{"type":"boolean","default":false,"description":"True when more annotations exist than were returned (the list is partial). The server always sends an explicit value; the default keeps older bare payloads parseable as complete."},"nextCursor":{"type":"string","nullable":true,"default":null,"description":"Opaque cursor for the next (later) page; null on the last page."}},"required":["annotations"],"additionalProperties":false,"description":"The caller’s own notes and highlights plus the ones shared with the deal team, by page."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, document or annotation, no access, a guest (external group), a support session or cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"post":{"operationId":"createDocumentAnnotation","summary":"Add a note or highlight to a page","description":"document.annotate on the document node. Private by default; `shared` makes it visible to the deal team of the room. Writes `document.annotated` (annotation id, kind, page, shared flag; never the text).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"pageNo":{"type":"integer","minimum":1,"maximum":100000},"kind":{"type":"string","enum":["note","highlight"],"description":"note = text on a page (optionally with an area); highlight = a marked area (optionally with text)."},"rect":{"type":"object","nullable":true,"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"Left edge as a fraction of the page width."},"y":{"type":"number","minimum":0,"maximum":1,"description":"Top edge as a fraction of the page height."},"w":{"type":"number","minimum":0,"exclusiveMinimum":true,"maximum":1,"description":"Width as a fraction of the page width."},"h":{"type":"number","minimum":0,"exclusiveMinimum":true,"maximum":1,"description":"Height as a fraction of the page height."}},"required":["x","y","w","h"],"additionalProperties":false,"description":"A rectangle in page fractions (origin top left)."},"body":{"type":"string","nullable":true,"minLength":1,"maxLength":4000},"shared":{"type":"boolean","default":false}},"required":["pageNo","kind","rect","body"],"additionalProperties":false,"description":"Add a note or highlight to a page of the document."}}}},"responses":{"201":{"description":"Added.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"pageNo":{"type":"integer","minimum":1},"kind":{"type":"string","enum":["note","highlight"],"description":"note = text on a page (optionally with an area); highlight = a marked area (optionally with text)."},"rect":{"type":"object","nullable":true,"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"Left edge as a fraction of the page width."},"y":{"type":"number","minimum":0,"maximum":1,"description":"Top edge as a fraction of the page height."},"w":{"type":"number","minimum":0,"exclusiveMinimum":true,"maximum":1,"description":"Width as a fraction of the page width."},"h":{"type":"number","minimum":0,"exclusiveMinimum":true,"maximum":1,"description":"Height as a fraction of the page height."}},"required":["x","y","w","h"],"additionalProperties":false,"description":"A rectangle in page fractions (origin top left)."},"body":{"type":"string","nullable":true,"description":"Note text (client data)."},"authorId":{"type":"string","format":"uuid"},"authorName":{"type":"string","nullable":true},"own":{"type":"boolean","description":"The caller made it (and may remove it)."},"shared":{"type":"boolean","description":"Visible to the deal team of the room."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","documentId","pageNo","kind","rect","body","authorId","authorName","own","shared","createdAt","updatedAt"],"additionalProperties":false,"description":"A personal note or highlight on a document page."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, document or annotation, no access, a guest (external group), a support session or cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/annotations/{annotationId}":{"patch":{"operationId":"updateDocumentAnnotation","summary":"Share an own annotation with the deal team, or make it private again","description":"document.annotate; own annotations only (another author’s is 404). Writes `document.annotated`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Annotation id."},"required":true,"description":"Annotation id.","name":"annotationId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"shared":{"type":"boolean"}},"required":["shared"],"additionalProperties":false,"description":"Share an own annotation with the deal team, or make it private again."}}}},"responses":{"200":{"description":"The annotation.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"pageNo":{"type":"integer","minimum":1},"kind":{"type":"string","enum":["note","highlight"],"description":"note = text on a page (optionally with an area); highlight = a marked area (optionally with text)."},"rect":{"type":"object","nullable":true,"properties":{"x":{"type":"number","minimum":0,"maximum":1,"description":"Left edge as a fraction of the page width."},"y":{"type":"number","minimum":0,"maximum":1,"description":"Top edge as a fraction of the page height."},"w":{"type":"number","minimum":0,"exclusiveMinimum":true,"maximum":1,"description":"Width as a fraction of the page width."},"h":{"type":"number","minimum":0,"exclusiveMinimum":true,"maximum":1,"description":"Height as a fraction of the page height."}},"required":["x","y","w","h"],"additionalProperties":false,"description":"A rectangle in page fractions (origin top left)."},"body":{"type":"string","nullable":true,"description":"Note text (client data)."},"authorId":{"type":"string","format":"uuid"},"authorName":{"type":"string","nullable":true},"own":{"type":"boolean","description":"The caller made it (and may remove it)."},"shared":{"type":"boolean","description":"Visible to the deal team of the room."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","documentId","pageNo","kind","rect","body","authorId","authorName","own","shared","createdAt","updatedAt"],"additionalProperties":false,"description":"A personal note or highlight on a document page."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, document or annotation, no access, a guest (external group), a support session or cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"delete":{"operationId":"deleteDocumentAnnotation","summary":"Remove an own note or highlight","description":"document.annotate; own annotations only. Writes `document.annotation_removed`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Annotation id."},"required":true,"description":"Annotation id.","name":"annotationId","in":"path"}],"responses":{"204":{"description":"Removed."},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, document or annotation, no access, a guest (external group), a support session or cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/review":{"put":{"operationId":"setDocumentReview","summary":"Mark a document as reviewed by me (or clear the mark)","description":"document.annotate on the document node. One marker per person per document. Writes `document.review_marked` (the flag only).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reviewed":{"type":"boolean","description":"true = mark reviewed by me; false = clear my mark."}},"required":["reviewed"],"additionalProperties":false,"description":"Set the caller’s \"reviewed\" marker on the document (VIEW-08)."}}}},"responses":{"200":{"description":"The marker.","content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid"},"reviewed":{"type":"boolean"},"reviewedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["documentId","reviewed","reviewedAt"],"additionalProperties":false,"description":"The caller’s review marker on a document."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, document or annotation, no access, a guest (external group), a support session or cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/review-progress":{"get":{"operationId":"getRoomReviewProgress","summary":"\"12 of 40 reviewed\": my review progress in a room","description":"room.read for a firm user who is a member of the room; guests get 404. Counts the live documents of the room the caller may see and the ones the caller marked reviewed.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"The progress.","content":{"application/json":{"schema":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid"},"total":{"type":"integer","minimum":0,"description":"Documents of the room the caller may see."},"reviewed":{"type":"integer","minimum":0,"description":"Of those, marked reviewed by the caller."},"reviewedDocumentIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000}},"required":["roomId","total","reviewed","reviewedDocumentIds"],"additionalProperties":false,"description":"\"12 of 40 reviewed\" for the caller in this room."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, document or annotation, no access, a guest (external group), a support session or cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/sms/delivery-reports/{provider}":{"post":{"operationId":"receiveSmsDeliveryReport","summary":"Receive an SMS delivery report from the SMS provider","description":"Public, server-to-server (ADR-0057 D5): the configured online SMS provider posts delivery reports here. No session and no CSRF origin (the documented exemption, like the Keycloak backchannel logout). The path provider must equal DDR_SMS_DRIVER and the report must verify: GatewayAPI signs every report with an HS256 JWT in `X-Gwapi-Signature` (the signed claims are used, not the body); CM.com does not sign, so its status-report URL carries a shared `token` query parameter compared in constant time. A verified report stores only a normalised status (accepted, delivered, failed, unknown) and its time on the SMS row found by our own message reference; a final status is never overwritten. The answer is the same 204 whether or not the reference is known, so the endpoint is no oracle. Rate limited per IP (webhook bucket). Nothing is audited: a delivery report is provider telemetry, not a user action; the guest code events stay auth.guest_code_sent and auth.step_up_*.","parameters":[{"schema":{"type":"string","enum":["cm","gatewayapi"],"description":"The SMS provider that sends this report; must equal the configured DDR_SMS_DRIVER."},"required":true,"description":"The SMS provider that sends this report; must equal the configured DDR_SMS_DRIVER.","name":"provider","in":"path"},{"schema":{"type":"string","maxLength":256,"description":"CM.com only: the shared webhook token configured with the status-report URL (CM.com does not sign its reports). Never logged."},"required":false,"description":"CM.com only: the shared webhook token configured with the status-report URL (CM.com does not sign its reports). Never logged.","name":"token","in":"query"},{"schema":{"type":"string","description":"GatewayAPI only: HS256 JWT over the report, signed with the webhook secret."},"required":false,"description":"GatewayAPI only: HS256 JWT over the report, signed with the webhook secret.","name":"x-gwapi-signature","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"nullable":true},"description":"Provider-specific delivery report (CM.com status report JSON or GatewayAPI webhook JSON)."}}}},"responses":{"204":{"description":"Report verified (stored when the reference is known; uniform answer)."},"400":{"description":"Malformed report.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Missing or invalid signature or token.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"No online SMS provider configured, or the path names another provider.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/archive-jobs":{"post":{"operationId":"createRoomArchiveJob","summary":"Start a full room archive (ZIP) for closing or handing over the room","description":"Requires `room.export.download` (`manage` on the room root, firm users only, fresh MFA). Queues a worker job that builds one ZIP with every live document (latest version, original file, folder structure with index numbers), the index (CSV and PDF), the audit trail with its hash proof (CSV and PDF), the Q&A log (XLSX, rooms with Q&A), the members list and the permissions matrix (XLSX), the room terms and a `manifest.json` with a SHA-256 per file. A legal hold does not block the archive (only destruction). 413 `ARCHIVE_TOO_LARGE` above 500 documents or 512 MiB; 409 `NOTHING_TO_ARCHIVE` when the room has no available document. Writes `export.created` (`export_kind: full`) when built.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"202":{"description":"Queued.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Download job id."},"roomId":{"type":"string","format":"uuid","description":"Room of the selection."},"status":{"type":"string","enum":["queued","building","ready","failed","expired"],"description":"Build state of a bulk download."},"format":{"type":"string","enum":["original","pdf","archive"],"description":"What the ZIP holds: original files, watermarked PDFs, or the full room archive."},"documentCount":{"type":"integer","minimum":0,"description":"Documents that go into the ZIP."},"skippedCount":{"type":"integer","minimum":0,"description":"Visible documents left out (no download right or not available); listed in the README."},"progress":{"type":"object","properties":{"done":{"type":"integer","minimum":0,"description":"Documents written so far."},"total":{"type":"integer","minimum":0,"description":"Documents to write."}},"required":["done","total"],"description":"Build progress."},"sizeBytes":{"type":"integer","nullable":true,"minimum":0,"description":"ZIP size once built."},"failureCode":{"type":"string","nullable":true,"pattern":"^[A-Z][A-Z0-9_]{0,62}$","description":"Why the build failed; null otherwise."},"createdAt":{"type":"string","format":"date-time","description":"When the job was created."},"completedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the build finished."},"expiresAt":{"type":"string","format":"date-time","description":"When the ZIP stops being downloadable."}},"required":["id","roomId","status","format","documentCount","skippedCount","progress","sizeBytes","failureCode","createdAt","completedAt","expiresAt"],"description":"A full room archive job (ids, counts and codes only); `format` is `archive`."}}}},"401":{"description":"Signed out, or stronger authentication is required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Not a room manager.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Nothing to archive.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"413":{"description":"The room is too large for one archive.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Too many archives in progress.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/archive-jobs/{jobId}":{"get":{"operationId":"getRoomArchiveJob","summary":"Read the progress of a full room archive","description":"Only the creator of the job; anyone else (and another tenant) gets 404. Ids, counts and codes only.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Archive job id."},"required":true,"description":"Archive job id.","name":"jobId","in":"path"}],"responses":{"200":{"description":"The job.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Download job id."},"roomId":{"type":"string","format":"uuid","description":"Room of the selection."},"status":{"type":"string","enum":["queued","building","ready","failed","expired"],"description":"Build state of a bulk download."},"format":{"type":"string","enum":["original","pdf","archive"],"description":"What the ZIP holds: original files, watermarked PDFs, or the full room archive."},"documentCount":{"type":"integer","minimum":0,"description":"Documents that go into the ZIP."},"skippedCount":{"type":"integer","minimum":0,"description":"Visible documents left out (no download right or not available); listed in the README."},"progress":{"type":"object","properties":{"done":{"type":"integer","minimum":0,"description":"Documents written so far."},"total":{"type":"integer","minimum":0,"description":"Documents to write."}},"required":["done","total"],"description":"Build progress."},"sizeBytes":{"type":"integer","nullable":true,"minimum":0,"description":"ZIP size once built."},"failureCode":{"type":"string","nullable":true,"pattern":"^[A-Z][A-Z0-9_]{0,62}$","description":"Why the build failed; null otherwise."},"createdAt":{"type":"string","format":"date-time","description":"When the job was created."},"completedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the build finished."},"expiresAt":{"type":"string","format":"date-time","description":"When the ZIP stops being downloadable."}},"required":["id","roomId","status","format","documentCount","skippedCount","progress","sizeBytes","failureCode","createdAt","completedAt","expiresAt"],"description":"A full room archive job (ids, counts and codes only); `format` is `archive`."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or another principal).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/archive-jobs/{jobId}/download":{"get":{"operationId":"downloadRoomArchiveJob","summary":"Download a built full room archive (ZIP)","description":"Only the creator, who must still hold `room.export.download` (fresh MFA). Streams the decrypted ZIP verified against its recorded hash and writes `export.downloaded` (`export_kind: full`) before the first byte. 409 `DOWNLOAD_NOT_READY` while building, 410 `DOWNLOAD_EXPIRED` after 7 days.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Archive job id."},"required":true,"description":"Archive job id.","name":"jobId","in":"path"}],"responses":{"200":{"description":"The ZIP.","headers":{"Content-Disposition":{"schema":{"type":"string","description":"`attachment` with a sanitised file name."},"required":true,"description":"`attachment` with a sanitised file name."},"Cache-Control":{"schema":{"type":"string","enum":["no-store"],"description":"Never cached."},"required":true,"description":"Never cached."}},"content":{"application/zip":{"schema":{"type":"string","description":"The ZIP bytes."}}}},"401":{"description":"Signed out, or stronger authentication is required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"No longer a room manager.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or another principal).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Not built yet, or the build failed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"410":{"description":"Expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"AUDIT_UNAVAILABLE: the audit event could not be written; nothing was served (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/members-overview":{"get":{"operationId":"getRoomMembersOverview","summary":"Users and groups overview of a room","description":"Requires `room.membership.read` (`manage` on the room root, or firm admin/compliance; firm users only). Every member and guest with group, effective level on the room root, status (invited, active, blocked, expired), last sign-in into the firm, last document activity in the room and the pending invitation to resend. Names and addresses are served to the authorised reader and never logged.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"The overview.","content":{"application/json":{"schema":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid"},"generatedAt":{"type":"string","format":"date-time"},"members":{"type":"array","items":{"type":"object","properties":{"principalId":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["user","guest"]},"displayName":{"type":"string","nullable":true,"maxLength":200,"description":"Profile name, or null when unknown."},"email":{"type":"string","nullable":true,"maxLength":254,"description":"Sign-in address when known (guests: the invited address)."},"groupId":{"type":"string","format":"uuid"},"groupName":{"type":"string","nullable":true,"maxLength":200},"groupKind":{"type":"string","enum":["internal","client","counterparty","expert","custom_external"]},"effectiveRead":{"type":"string","enum":["none","view","print","download"],"description":"Effective read level on the room root."},"effectiveWrite":{"type":"string","enum":["none","upload_with_approval","upload","edit","manage"],"description":"Effective write level on the room root."},"status":{"type":"string","enum":["invited","active","blocked","expired"],"description":"invited = the invitation is pending and the person never signed in; blocked = the principal is blocked; expired = the membership, group or external access deadline passed."},"membershipExpiresAt":{"type":"string","nullable":true,"format":"date-time"},"lastSignInAt":{"type":"string","nullable":true,"format":"date-time","description":"Last sign-in into this firm (session start)."},"lastDocumentActivityAt":{"type":"string","nullable":true,"format":"date-time","description":"Last page read in this room (engagement)."},"pendingInvitationId":{"type":"string","nullable":true,"format":"uuid","description":"The pending invitation to resend, when there is one."}},"required":["principalId","kind","displayName","email","groupId","groupName","groupKind","effectiveRead","effectiveWrite","status","membershipExpiresAt","lastSignInAt","lastDocumentActivityAt","pendingInvitationId"],"description":"One member or guest of the room with the effective level on the room root."},"maxItems":5000}},"required":["roomId","generatedAt","members"],"description":"Every member and guest of the room (PERM-17)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without the right).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/members-overview/export":{"get":{"operationId":"exportRoomMembersOverview","summary":"Export the users and groups overview as XLSX","description":"Same right as the overview. One sheet with the same columns (TM-EXP-02 formula neutralisation). Writes `export.created` (`export_kind: members`) before the first byte (fail closed, 503).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"The workbook.","headers":{"Content-Disposition":{"schema":{"type":"string","description":"`attachment` with a sanitised file name."},"required":true,"description":"`attachment` with a sanitised file name."},"Cache-Control":{"schema":{"type":"string","enum":["no-store"],"description":"Never cached."},"required":true,"description":"Never cached."}},"content":{"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","description":"The XLSX bytes."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without the right).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"AUDIT_UNAVAILABLE: the audit event could not be written; nothing was served (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/permissions/export":{"get":{"operationId":"exportRoomPermissionMatrix","summary":"Export the permissions matrix (folder x group) as XLSX","description":"Requires `room.group.read` (`manage` on the room root, or firm admin/compliance; firm users only). One row per folder and document in index order (number, title), one column pair per group with the effective read and write level, plus a sheet with the group settings. Writes `export.created` (`export_kind: permissions`) before the first byte (fail closed, 503).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"The workbook.","headers":{"Content-Disposition":{"schema":{"type":"string","description":"`attachment` with a sanitised file name."},"required":true,"description":"`attachment` with a sanitised file name."},"Cache-Control":{"schema":{"type":"string","enum":["no-store"],"description":"Never cached."},"required":true,"description":"Never cached."}},"content":{"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","description":"The XLSX bytes."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without the right).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"AUDIT_UNAVAILABLE: the audit event could not be written; nothing was served (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/access-settings":{"get":{"operationId":"getRoomAccessSettings","summary":"Read the room access settings (IP allow-list, scheduled freeze, external deadline)","description":"Requires `room.membership.read` (`manage` on the room root, or firm admin/compliance; firm users only). Non-mutating, so it loads in a frozen or closed room.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"The settings.","content":{"application/json":{"schema":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid"},"state":{"type":"string","enum":["active","frozen","closed","archived"],"description":"Room states visible through this API (destroying/destroyed are never listed)."},"ipAllowList":{"type":"array","items":{"type":"string","maxLength":64,"pattern":"^(?:(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}(?:\\/(?:3[0-2]|[12]?\\d))?|[0-9a-fA-F:]{2,39}(?:\\/(?:12[0-8]|1[01]\\d|[1-9]?\\d))?)$","description":"An IPv4/IPv6 address or CIDR range."},"maxItems":64,"description":"Client addresses that may open the room; empty = no restriction (PERM-11)."},"ipAllowListFirmUsers":{"type":"boolean","description":"Firm setting: the allow-list also applies to the firm’s own users (read-only here)."},"freezeScheduledAt":{"type":"string","nullable":true,"format":"date-time","description":"When the worker sweep freezes the room (read-only), or null (MAT-10)."},"externalAccessUntil":{"type":"string","nullable":true,"format":"date-time","description":"When external groups lose access (PERM-09), or null."},"externalBlockApplied":{"type":"boolean","description":"Whether the external deadline has passed and was audited."}},"required":["roomId","state","ipAllowList","ipAllowListFirmUsers","freezeScheduledAt","externalAccessUntil","externalBlockApplied"],"description":"Room access settings (ADR-0050)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without the right).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"patch":{"operationId":"updateRoomAccessSettings","summary":"Update the room access settings","description":"Requires `room.settings.update` (`manage` on the room root, firm users only; mutating, so refused with `READ_ONLY` outside an active room). The IP allow-list (CIDR, at most 64) is enforced server-side on every room route for external groups, and for firm users too when the firm setting says so; a denied guest gets 404, a denied firm user 403 `IP_NOT_ALLOWED`, both audited as `access.denied` with ids only. A scheduled freeze is applied by the worker sweep (`room.state_changed`); the external deadline is enforced immediately by the database and audited once it passes (`room.external_access_ended`). Writes `room.settings_changed` with the changed setting codes only.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ipAllowList":{"type":"array","items":{"type":"string","maxLength":64,"pattern":"^(?:(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}(?:\\/(?:3[0-2]|[12]?\\d))?|[0-9a-fA-F:]{2,39}(?:\\/(?:12[0-8]|1[01]\\d|[1-9]?\\d))?)$","description":"An IPv4/IPv6 address or CIDR range."},"maxItems":64},"freezeScheduledAt":{"type":"string","nullable":true,"format":"date-time","description":"null clears the schedule."},"externalAccessUntil":{"type":"string","nullable":true,"format":"date-time","description":"null clears the deadline."}},"additionalProperties":false,"description":"Partial update of the room access settings; only the provided keys change."}}}},"responses":{"200":{"description":"The updated settings.","content":{"application/json":{"schema":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid"},"state":{"type":"string","enum":["active","frozen","closed","archived"],"description":"Room states visible through this API (destroying/destroyed are never listed)."},"ipAllowList":{"type":"array","items":{"type":"string","maxLength":64,"pattern":"^(?:(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}(?:\\/(?:3[0-2]|[12]?\\d))?|[0-9a-fA-F:]{2,39}(?:\\/(?:12[0-8]|1[01]\\d|[1-9]?\\d))?)$","description":"An IPv4/IPv6 address or CIDR range."},"maxItems":64,"description":"Client addresses that may open the room; empty = no restriction (PERM-11)."},"ipAllowListFirmUsers":{"type":"boolean","description":"Firm setting: the allow-list also applies to the firm’s own users (read-only here)."},"freezeScheduledAt":{"type":"string","nullable":true,"format":"date-time","description":"When the worker sweep freezes the room (read-only), or null (MAT-10)."},"externalAccessUntil":{"type":"string","nullable":true,"format":"date-time","description":"When external groups lose access (PERM-09), or null."},"externalBlockApplied":{"type":"boolean","description":"Whether the external deadline has passed and was audited."}},"required":["roomId","state","ipAllowList","ipAllowListFirmUsers","freezeScheduledAt","externalAccessUntil","externalBlockApplied"],"description":"Room access settings (ADR-0050)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Not a room manager, or the room is not active.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/flows/{flowId}/items/{itemId}/files/{fileId}/bsn-mask":{"post":{"operationId":"maskFlowItemFileBsn","summary":"Burn every BSN out of a delivered file","description":"Asks the worker to burn every number that passes the BSN eleven-test out of the delivered file (ADR-0040 burn-in: a new image-only version; the original becomes internal-only). Items with automatic masking never need this. Requires flow_item.review on the item (manage, users only); 404 hides the item; 409 CONFLICT when the file is not submitted or masking is already pending. Writes flow_item.bsn_mask_requested (ids only); the worker writes flow_item.bsn_masked with counts only.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"fileId","in":"path"}],"responses":{"202":{"description":"Masking queued; the updated request.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"templateId":{"type":"string","nullable":true,"maxLength":100},"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipient":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"email":{"type":"string","maxLength":320,"format":"email"}},"required":["name","email"],"description":"The one person a request is addressed to (client data)."},"portalUrl":{"type":"string","nullable":true,"description":"Always null on the real stack: the link token is only ever in the request e-mail."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group bound to the party; null until the firm binds it."}},"required":["slot","label","groupId"],"additionalProperties":false,"description":"Room-bound party of a request (WF01): applicant slot, display label, room group."},"description":"Named room parties of this request (WF01); empty on legacy rows without a scope."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): bound parties share drafts. False keeps slot-private answers."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance. Null on legacy rows without a period."},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."},"targetFolderId":{"type":"string","nullable":true,"format":"uuid","description":"Room-index folder the approved files go into; null = root."},"targetFolderTitle":{"type":"string","nullable":true},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"overdue":{"type":"boolean"},"authStrength":{"type":"string","nullable":true,"enum":["single","mfa",null],"description":"Strength of the client session that submitted the item (ADR-0013 D1 condition 1)."},"bsnAutoMask":{"type":"boolean","description":"The worker burns every BSN out of a delivered file before approval (ADR-0053)."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number","targetFolderId","targetFolderTitle","submittedAt","overdue","authStrength"],"description":"Request item as the firm sees it."}},"createdAt":{"type":"string","format":"date-time"},"sentAt":{"type":"string","nullable":true,"format":"date-time"},"openedAt":{"type":"string","nullable":true,"format":"date-time"},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"reminders":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"description":"Reminders sent so far (automatic and manual)."},"lastAt":{"type":"string","nullable":true,"format":"date-time"},"nextAt":{"type":"string","nullable":true,"format":"date-time","description":"Next automatic reminder; null when none is due."},"paused":{"type":"boolean"}},"required":["count","lastAt","nextAt","paused"],"description":"Reminder state (ADR-0053)."}},"required":["id","roomId","templateId","title","message","status","dueDate","recipient","portalUrl","parties","joint","periodContext","expiresAt","coverInstructions","displayStatus","progress","sections","items","createdAt","sentAt","openedAt","submittedAt","completedAt","updatedAt"],"description":"Document request (request-flow profile, firm view)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no manage on the item).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, request, item or file.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"CONFLICT: not a submitted file, or masking already pending.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/flows/{flowId}/reminders":{"post":{"operationId":"sendFlowReminder","summary":"Send a reminder for an open request now","description":"Sends the request reminder e-mail (NL/EN, firm name, open item count and a fresh link token that exists only in that e-mail) to the recipient and counts it on the request. Requires flow.create on the room (manage). 409 CONFLICT when the request is not sent, its link has expired or was revoked, or the recipient is not active. Writes flow.reminder_sent (ids and the count).","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"}],"responses":{"200":{"description":"The updated request.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"templateId":{"type":"string","nullable":true,"maxLength":100},"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipient":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"email":{"type":"string","maxLength":320,"format":"email"}},"required":["name","email"],"description":"The one person a request is addressed to (client data)."},"portalUrl":{"type":"string","nullable":true,"description":"Always null on the real stack: the link token is only ever in the request e-mail."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group bound to the party; null until the firm binds it."}},"required":["slot","label","groupId"],"additionalProperties":false,"description":"Room-bound party of a request (WF01): applicant slot, display label, room group."},"description":"Named room parties of this request (WF01); empty on legacy rows without a scope."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): bound parties share drafts. False keeps slot-private answers."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance. Null on legacy rows without a period."},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."},"targetFolderId":{"type":"string","nullable":true,"format":"uuid","description":"Room-index folder the approved files go into; null = root."},"targetFolderTitle":{"type":"string","nullable":true},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"overdue":{"type":"boolean"},"authStrength":{"type":"string","nullable":true,"enum":["single","mfa",null],"description":"Strength of the client session that submitted the item (ADR-0013 D1 condition 1)."},"bsnAutoMask":{"type":"boolean","description":"The worker burns every BSN out of a delivered file before approval (ADR-0053)."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number","targetFolderId","targetFolderTitle","submittedAt","overdue","authStrength"],"description":"Request item as the firm sees it."}},"createdAt":{"type":"string","format":"date-time"},"sentAt":{"type":"string","nullable":true,"format":"date-time"},"openedAt":{"type":"string","nullable":true,"format":"date-time"},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"reminders":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"description":"Reminders sent so far (automatic and manual)."},"lastAt":{"type":"string","nullable":true,"format":"date-time"},"nextAt":{"type":"string","nullable":true,"format":"date-time","description":"Next automatic reminder; null when none is due."},"paused":{"type":"boolean"}},"required":["count","lastAt","nextAt","paused"],"description":"Reminder state (ADR-0053)."}},"required":["id","roomId","templateId","title","message","status","dueDate","recipient","portalUrl","parties","joint","periodContext","expiresAt","coverInstructions","displayStatus","progress","sections","items","createdAt","sentAt","openedAt","submittedAt","completedAt","updatedAt"],"description":"Document request (request-flow profile, firm view)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no manage on the room).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or request.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"CONFLICT: the request is not open for reminders.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/wwft-summary":{"get":{"operationId":"getWwftSummary","summary":"Wwft-dossier summary of a room","description":"The Wwft identification items of the room (from the request section \"Identificatie (Wwft)\"): what was received and when, whether the delivered file was BSN-masked, and the wwft_cdd retention class (5 years after the end of the relationship). Requires flow.read on the room (users only); refusals are 404.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"The summary.","content":{"application/json":{"schema":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid"},"flowId":{"type":"string","nullable":true,"format":"uuid","description":"The request that carries the Wwft section; null when none."},"flowStatus":{"type":"string","nullable":true,"enum":["draft","sent","completed","closed",null],"description":"Flow state (INT-F03, INT-F18)."},"items":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["identity","ubo","source_of_funds","other"],"description":"Document kind, derived from the item title of the Wwft section."},"title":{"type":"string","description":"Item title (organisation content of the template)."},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"receivedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the client delivered it."},"approvedAt":{"type":"string","nullable":true,"format":"date-time"},"bsnMasked":{"type":"boolean","description":"The delivered file was masked by the worker (ADR-0053)."}},"required":["kind","title","status","receivedAt","approvedAt","bsnMasked"],"description":"One Wwft checklist item of the room."}},"received":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0},"complete":{"type":"boolean","description":"Every required Wwft item is approved or not applicable."},"retention":{"type":"object","properties":{"classId":{"type":"string","enum":["wwft_cdd"]},"years":{"type":"integer","minimum":1,"description":"Retention after the end of the relationship (Wwft art. 33)."},"assigned":{"type":"boolean","description":"The class is assigned to the room (ADR-0012)."}},"required":["classId","years","assigned"]}},"required":["roomId","flowId","flowStatus","items","received","total","complete","retention"],"description":"Wwft-dossier summary of a room (ADR-0053)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room, or no access.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/api-keys":{"get":{"operationId":"listApiKeys","summary":"List the API keys of the firm","description":"Every key with its name, prefix, scopes, creator, expiry, last use and status; never the secret. Firm admin and compliance only (`api_key.read`). Not callable with an API key.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"The keys, newest first, with an explicit partial-list signal.","content":{"application/json":{"schema":{"type":"object","properties":{"keys":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"API key id."},"name":{"type":"string","minLength":1,"maxLength":80},"prefix":{"type":"string","minLength":4,"maxLength":16},"scopes":{"type":"array","items":{"type":"string","enum":["rooms.read","rooms.write","documents.read","documents.upload","documents.write","flows.read","flows.write","exhibits.read","exhibits.write","messaging.read","messaging.write","qa.read","qa.write","team.read","team.write","office.read","office.write","audit.read","billing.read","outlook.addin"],"description":"One API key scope."},"minItems":1},"createdBy":{"type":"string","format":"uuid","description":"Principal id of the creating firm admin; the key acts as this principal."},"createdAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"},"lastUsedAt":{"type":"string","nullable":true,"format":"date-time"},"revokedAt":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["active","expired","revoked"]},"roomIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":50,"description":"Data rooms the key is limited to (ADR-0067); empty means firm-wide."},"personal":{"type":"boolean","description":"A member created this key for themselves under Mijn koppelingen (ADR-0067 D4): read-only scopes, refused while the firm switch is off."},"allowedCidrs":{"type":"array","items":{"type":"string"},"maxItems":20,"description":"Networks the key may be used from (ADR-0067 D6); empty means any address."},"rateLimitPerMinute":{"type":"integer","nullable":true,"minimum":1,"maximum":1000,"description":"Requests per minute for this key; null means the platform default (300)."},"rotatedFrom":{"type":"string","nullable":true,"format":"uuid","description":"The key this one replaced by rotation (ADR-0067 D6), if any."}},"required":["id","name","prefix","scopes","createdBy","createdAt","expiresAt","lastUsedAt","revokedAt","status","roomIds","personal","allowedCidrs","rateLimitPerMinute","rotatedFrom"],"description":"One API key of the firm (never the secret)."},"description":"API keys of the firm, newest first."},"truncated":{"type":"boolean","description":"True when more keys exist than were returned (the list is partial)."}},"required":["keys","truncated"]}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: not a firm admin (guests, support, services and API keys never).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"post":{"operationId":"createApiKey","summary":"Create an API key (secret shown once)","description":"Firm admin only (`api_key.manage`). The key acts as the calling admin, limited to the chosen scopes; it expires after `expiresInDays` (default 90, max 365). With `roomIds` the key is limited to those data rooms (ADR-0067): any other room, and any firm-wide operation outside `getMe`, `mcpInvoke` and `listMyRooms`, answers 403 `ROOM_OUT_OF_SCOPE`; an unknown or unreachable room is 404. The secret is returned once and stored as a SHA-256 hash. Audited as `api_key.created` (ids only, with `room_ids`).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"scopes":{"type":"array","items":{"type":"string","enum":["rooms.read","rooms.write","documents.read","documents.upload","documents.write","flows.read","flows.write","exhibits.read","exhibits.write","messaging.read","messaging.write","qa.read","qa.write","team.read","team.write","office.read","office.write","audit.read","billing.read","outlook.addin"],"description":"One API key scope."},"minItems":1,"maxItems":20},"expiresInDays":{"type":"integer","minimum":1,"maximum":365,"default":90},"roomIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":50,"description":"Limit the key to these data rooms (ADR-0067). Each room must exist and be live; an unknown room is 404. Absent or empty: firm-wide."},"allowedCidrs":{"type":"array","items":{"type":"string","maxLength":64},"maxItems":20,"description":"Only accept the key from these networks (ADR-0067 D6); elsewhere 403 IP_NOT_ALLOWED."},"rateLimitPerMinute":{"type":"integer","minimum":1,"maximum":1000,"description":"Requests per minute for this key (default 300)."}},"required":["name","scopes"],"additionalProperties":false,"description":"Create an API key."}}}},"responses":{"201":{"description":"The key and its secret.","content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"API key id."},"name":{"type":"string","minLength":1,"maxLength":80},"prefix":{"type":"string","minLength":4,"maxLength":16},"scopes":{"type":"array","items":{"type":"string","enum":["rooms.read","rooms.write","documents.read","documents.upload","documents.write","flows.read","flows.write","exhibits.read","exhibits.write","messaging.read","messaging.write","qa.read","qa.write","team.read","team.write","office.read","office.write","audit.read","billing.read","outlook.addin"],"description":"One API key scope."},"minItems":1},"createdBy":{"type":"string","format":"uuid","description":"Principal id of the creating firm admin; the key acts as this principal."},"createdAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"},"lastUsedAt":{"type":"string","nullable":true,"format":"date-time"},"revokedAt":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["active","expired","revoked"]},"roomIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":50,"description":"Data rooms the key is limited to (ADR-0067); empty means firm-wide."},"personal":{"type":"boolean","description":"A member created this key for themselves under Mijn koppelingen (ADR-0067 D4): read-only scopes, refused while the firm switch is off."},"allowedCidrs":{"type":"array","items":{"type":"string"},"maxItems":20,"description":"Networks the key may be used from (ADR-0067 D6); empty means any address."},"rateLimitPerMinute":{"type":"integer","nullable":true,"minimum":1,"maximum":1000,"description":"Requests per minute for this key; null means the platform default (300)."},"rotatedFrom":{"type":"string","nullable":true,"format":"uuid","description":"The key this one replaced by rotation (ADR-0067 D6), if any."}},"required":["id","name","prefix","scopes","createdBy","createdAt","expiresAt","lastUsedAt","revokedAt","status","roomIds","personal","allowedCidrs","rateLimitPerMinute","rotatedFrom"],"description":"One API key of the firm (never the secret)."},"secret":{"type":"string","pattern":"^ddr_[A-Za-z0-9_-]{84}$"}},"required":["key","secret"],"description":"The created key and its secret (once)."}}}},"400":{"description":"Invalid body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: not a firm admin (guests, support, services and API keys never).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/api-keys/{keyId}":{"delete":{"operationId":"revokeApiKey","summary":"Revoke an API key","description":"Firm admin only (`api_key.manage`). Revocation is immediate and permanent; the row stays for the audit trail. Audited as `api_key.revoked`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"API key id."},"required":true,"description":"API key id.","name":"keyId","in":"path"}],"responses":{"204":{"description":"Revoked (or already revoked)."},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: not a firm admin (guests, support, services and API keys never).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/webhooks":{"get":{"operationId":"listWebhooks","summary":"List the webhook endpoints of the firm","description":"Every endpoint with its URL, subscriptions, state and last delivery; never the secret. Firm admin and compliance only (`webhook.read`). Not callable with an API key.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"The endpoints, newest first with an explicit truncated signal.","content":{"application/json":{"schema":{"type":"object","properties":{"endpoints":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Webhook endpoint id."},"url":{"type":"string","maxLength":2048},"events":{"type":"array","items":{"type":"string","enum":["document.uploaded","request.submitted","qa.question.asked","download.ready","room.closed","webhook.test"],"description":"One webhook event type."},"minItems":1},"active":{"type":"boolean"},"createdBy":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"deactivatedAt":{"type":"string","nullable":true,"format":"date-time"},"lastDeliveryAt":{"type":"string","nullable":true,"format":"date-time"},"lastStatus":{"type":"string","nullable":true,"enum":["pending","retrying","delivered","failed",null]}},"required":["id","url","events","active","createdBy","createdAt","deactivatedAt","lastDeliveryAt","lastStatus"],"description":"One webhook endpoint of the firm (never the secret)."},"description":"Webhook endpoints of the firm, newest first."},"truncated":{"type":"boolean","description":"True when more endpoints exist than were returned (the list is partial)."}},"required":["endpoints","truncated"]}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: not a firm admin (guests, support, services and API keys never).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"post":{"operationId":"createWebhook","summary":"Register a webhook endpoint (secret shown once)","description":"Firm admin only (`webhook.manage`). The URL must be https and public (private, loopback and link-local addresses are refused; loopback is allowed in local/test for the demo receiver). Where the endpoint is hosted is the firm’s responsibility. The HMAC-SHA256 secret is returned once. Audited as `webhook_endpoint.created`. At most 20 active endpoints per firm.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","minLength":8,"maxLength":2048,"description":"https URL; http only for loopback in local/test."},"events":{"type":"array","items":{"type":"string","enum":["document.uploaded","request.submitted","qa.question.asked","download.ready","room.closed"]},"minItems":1,"maxItems":5}},"required":["url","events"],"additionalProperties":false,"description":"Register a webhook endpoint."}}}},"responses":{"201":{"description":"The endpoint and its secret.","content":{"application/json":{"schema":{"type":"object","properties":{"endpoint":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Webhook endpoint id."},"url":{"type":"string","maxLength":2048},"events":{"type":"array","items":{"type":"string","enum":["document.uploaded","request.submitted","qa.question.asked","download.ready","room.closed","webhook.test"],"description":"One webhook event type."},"minItems":1},"active":{"type":"boolean"},"createdBy":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"deactivatedAt":{"type":"string","nullable":true,"format":"date-time"},"lastDeliveryAt":{"type":"string","nullable":true,"format":"date-time"},"lastStatus":{"type":"string","nullable":true,"enum":["pending","retrying","delivered","failed",null]}},"required":["id","url","events","active","createdBy","createdAt","deactivatedAt","lastDeliveryAt","lastStatus"],"description":"One webhook endpoint of the firm (never the secret)."},"secret":{"type":"string","pattern":"^whsec_[A-Za-z0-9_-]{43}$"}},"required":["endpoint","secret"],"description":"The registered endpoint and its signing secret (once)."}}}},"400":{"description":"Invalid body or refused URL.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: not a firm admin (guests, support, services and API keys never).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"CONFLICT: the endpoint limit is reached.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/webhooks/{webhookId}":{"delete":{"operationId":"deactivateWebhook","summary":"Deactivate a webhook endpoint","description":"Firm admin only (`webhook.manage`). Pending deliveries are dropped; the endpoint and its log stay for the audit trail. Audited as `webhook_endpoint.deactivated`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Webhook endpoint id."},"required":true,"description":"Webhook endpoint id.","name":"webhookId","in":"path"}],"responses":{"204":{"description":"Deactivated (or already inactive)."},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: not a firm admin (guests, support, services and API keys never).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/webhooks/{webhookId}/test":{"post":{"operationId":"testWebhook","summary":"Queue a test delivery (`webhook.test`)","description":"Firm admin only (`webhook.manage`). Queues one `webhook.test` delivery that the worker sends like any other; the result shows in the delivery log. Audited as `webhook_endpoint.tested`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Webhook endpoint id."},"required":true,"description":"Webhook endpoint id.","name":"webhookId","in":"path"}],"responses":{"202":{"description":"The queued delivery.","content":{"application/json":{"schema":{"type":"object","properties":{"delivery":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"endpointId":{"type":"string","format":"uuid","description":"Webhook endpoint id."},"eventType":{"type":"string","enum":["document.uploaded","request.submitted","qa.question.asked","download.ready","room.closed","webhook.test"],"description":"One webhook event type."},"status":{"type":"string","enum":["pending","retrying","delivered","failed"]},"attempts":{"type":"integer","minimum":0},"responseStatus":{"type":"integer","nullable":true},"errorCode":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"lastAttemptAt":{"type":"string","nullable":true,"format":"date-time"},"nextAttemptAt":{"type":"string","nullable":true,"format":"date-time"},"deliveredAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","endpointId","eventType","status","attempts","responseStatus","errorCode","createdAt","lastAttemptAt","nextAttemptAt","deliveredAt"],"description":"One delivery of the log (never the payload body)."}},"required":["delivery"]}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: not a firm admin (guests, support, services and API keys never).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"CONFLICT: the endpoint is inactive.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/webhooks/{webhookId}/deliveries":{"get":{"operationId":"listWebhookDeliveries","summary":"The delivery log of one endpoint","description":"The last 100 deliveries with status, attempts, response status and timestamps; never the payload. Firm admin and compliance only (`webhook.read`).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Webhook endpoint id."},"required":true,"description":"Webhook endpoint id.","name":"webhookId","in":"path"}],"responses":{"200":{"description":"The deliveries, newest first with an explicit truncated signal.","content":{"application/json":{"schema":{"type":"object","properties":{"deliveries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"endpointId":{"type":"string","format":"uuid","description":"Webhook endpoint id."},"eventType":{"type":"string","enum":["document.uploaded","request.submitted","qa.question.asked","download.ready","room.closed","webhook.test"],"description":"One webhook event type."},"status":{"type":"string","enum":["pending","retrying","delivered","failed"]},"attempts":{"type":"integer","minimum":0},"responseStatus":{"type":"integer","nullable":true},"errorCode":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"lastAttemptAt":{"type":"string","nullable":true,"format":"date-time"},"nextAttemptAt":{"type":"string","nullable":true,"format":"date-time"},"deliveredAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","endpointId","eventType","status","attempts","responseStatus","errorCode","createdAt","lastAttemptAt","nextAttemptAt","deliveredAt"],"description":"One delivery of the log (never the payload body)."},"description":"Deliveries of one endpoint, newest first."},"truncated":{"type":"boolean","description":"True when more deliveries exist than were returned (the list is partial)."}},"required":["deliveries","truncated"]}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: not a firm admin (guests, support, services and API keys never).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/nodes/{nodeId}/medical":{"put":{"operationId":"setNodeMedical","summary":"Mark or clear a special-category zone (\"Medisch\")","description":"`node.medical.mark` / `node.medical.clear` (`manage`, firm users, folders only, step-up). Marking makes the folder and its subtree reachable only through groups with `medicalAccess`; firm membership alone is not enough. Refused with 409 `MEDICAL_ZONE_REFUSED` when the caller would lock itself out (no group of the caller holds the flag). Writes `index_node.medical_marked` / `index_node.medical_unmarked`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Index node id (a folder)."},"required":true,"description":"Index node id (a folder).","name":"nodeId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"medical":{"type":"boolean","description":"true marks the folder \"Medisch\" (`node.medical.mark`); false clears it (`node.medical.clear`). Both need step-up."}},"required":["medical"],"additionalProperties":false,"description":"Mark or clear a special-category zone."}}}},"responses":{"200":{"description":"The zone state.","content":{"application/json":{"schema":{"type":"object","properties":{"nodeId":{"type":"string","format":"uuid"},"medicalMarked":{"type":"boolean","description":"The mark on this folder."},"medicalOnly":{"type":"boolean","description":"Materialised zone state: this folder or an ancestor is marked."},"markedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["nodeId","medicalMarked","medicalOnly","markedAt"],"description":"Special-category zone state of one folder."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"`STEP_UP_REQUIRED`: fresh authentication is required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Visible, but the caller lacks the level or role.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, node, group or client; no access; cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"`MEDICAL_ZONE_REFUSED` or `READ_ONLY`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/groups/{groupId}/medical-access":{"put":{"operationId":"setGroupMedicalAccess","summary":"Grant or withdraw a group's access to the special-category zones","description":"`group.medical_access.set` (`manage` on the room, firm users, step-up). Writes `group.medical_access_granted` / `group.medical_access_revoked` (group id only).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Group id."},"required":true,"description":"Group id.","name":"groupId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"medicalAccess":{"type":"boolean","description":"Grant (true) or withdraw (false) access to the special-category zones of the room."}},"required":["medicalAccess"],"additionalProperties":false,"description":"The zone flag of a group (`group.medical_access.set`, step-up)."}}}},"responses":{"200":{"description":"The flag.","content":{"application/json":{"schema":{"type":"object","properties":{"groupId":{"type":"string","format":"uuid"},"medicalAccess":{"type":"boolean"}},"required":["groupId","medicalAccess"],"description":"The zone flag of a group."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"`STEP_UP_REQUIRED`: fresh authentication is required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Visible, but the caller lacks the level or role.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, node, group or client; no access; cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"`MEDICAL_ZONE_REFUSED`: withdrawing the flag from the last internal group that holds it while the room has a zone (nobody at the firm could reach it any more).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/medical-log":{"get":{"operationId":"exportMedicalLog","summary":"Export the Medische Paragraaf information log (CSV or PDF)","description":"`room.medical_log.export` (`manage` on the room or the compliance role, firm users only). One row per recipient, medical document, version, basis and day: who received which medical information, when and how. Writes `medical_log.exported` (row count only) before the first byte.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","enum":["csv","pdf"],"description":"Default csv."},"required":false,"description":"Default csv.","name":"format","in":"query"},{"schema":{"type":"string","enum":["nl","en"],"description":"Language of headers and labels; default nl."},"required":false,"description":"Language of headers and labels; default nl.","name":"locale","in":"query"}],"responses":{"200":{"description":"The CSV (UTF-8 with BOM, formula-safe) or the PDF.","headers":{"Content-Disposition":{"schema":{"type":"string","description":"`attachment` with a file name made of the date only."},"required":true,"description":"`attachment` with a file name made of the date only."},"Cache-Control":{"schema":{"type":"string","enum":["no-store"]},"required":true}},"content":{"text/csv":{"schema":{"type":"string"}},"application/pdf":{"schema":{"type":"string"}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Visible, but the caller lacks the level or role.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, node, group or client; no access; cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"AUDIT_UNAVAILABLE: the audit event could not be written; nothing was served (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/clients/{clientId}/wwft":{"get":{"operationId":"getWwftDossier","summary":"Read the Wwft dossier of a client","description":"`wwft.dossier.read`. Writes `wwft_dossier.read` (client id only).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Client id."},"required":true,"description":"Client id.","name":"clientId","in":"path"}],"responses":{"200":{"description":"The dossier.","content":{"application/json":{"schema":{"type":"object","properties":{"clientId":{"type":"string","format":"uuid"},"clientName":{"type":"string","nullable":true},"exists":{"type":"boolean","description":"false when nothing has been recorded yet (all fields at their defaults)."},"identificationMethod":{"type":"string","enum":["none","id_copy","dci_wid","idin"],"description":"none, a copy of the ID document in the restricted \"Wwft\" folder, a DCI/WID report, or iDIN (placeholder)."},"identificationDocumentId":{"type":"string","nullable":true,"format":"uuid","description":"The ID copy or report in an internal \"Wwft\" folder of one of the client's rooms."},"identificationReference":{"type":"string","nullable":true,"description":"Report number or note (client data)."},"identifiedAt":{"type":"string","nullable":true,"format":"date-time"},"ubos":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200,"description":"Name of the ultimate beneficial owner (client data)."},"role":{"type":"string","enum":["owner","director","control","pseudo"],"description":"Ownership, director, other control, or pseudo-UBO."},"sharePercent":{"type":"integer","nullable":true,"minimum":0,"maximum":100,"description":"Share or control percentage."},"verified":{"type":"boolean","description":"Checked against the UBO register extract."}},"required":["name","role","sharePercent","verified"],"additionalProperties":false,"description":"One ultimate beneficial owner."}},"pepStatus":{"type":"string","enum":["unknown","no","yes"],"description":"Manual PEP check result."},"pepCheckedAt":{"type":"string","nullable":true,"format":"date-time"},"pepCheckedBy":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","nullable":true}},"required":["id","displayName"]},"riskClass":{"type":"string","enum":["unset","low","normal","high"],"description":"Risk classification."},"sourceOfFunds":{"type":"string","nullable":true,"description":"Source-of-funds notes (client data)."},"reviewDueOn":{"type":"string","nullable":true,"format":"date"},"lastReviewedAt":{"type":"string","nullable":true,"format":"date-time"},"relationshipEndedAt":{"type":"string","nullable":true,"format":"date-time"},"retentionUntil":{"type":"string","nullable":true,"format":"date","description":"End of the Wwft retention (class wwft_cdd, from the relationship end); null while the relationship runs."},"openMatterCount":{"type":"integer","minimum":0},"status":{"type":"string","enum":["complete","incomplete","review_due","ended"],"description":"complete, incomplete (see `missing`), review due, or the relationship has ended (retention running)."},"missing":{"type":"array","items":{"type":"string","enum":["identification","ubo","pep_check","risk_class","source_of_funds"]}},"updatedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["clientId","clientName","exists","identificationMethod","identificationDocumentId","identificationReference","identifiedAt","ubos","pepStatus","pepCheckedAt","pepCheckedBy","riskClass","sourceOfFunds","reviewDueOn","lastReviewedAt","relationshipEndedAt","retentionUntil","openMatterCount","status","missing","updatedAt"],"description":"The Wwft client-due-diligence record of one client."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"A firm user without a Wwft role (firm_admin, compliance, lawyer, adviser, legal_assistant), or a guest.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, node, group or client; no access; cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"AUDIT_UNAVAILABLE: the audit event could not be written; nothing was served (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"put":{"operationId":"updateWwftDossier","summary":"Change the Wwft dossier of a client","description":"`wwft.dossier.update`. Absent fields stay unchanged; `pepStatus` stamps the date and the checking user; `identificationDocumentId` must name a live document in an internal folder of a room of one of the client's matters (400 otherwise). Writes `wwft_dossier.updated` with the changed field codes only (never values).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Client id."},"required":true,"description":"Client id.","name":"clientId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"identificationMethod":{"type":"string","enum":["none","id_copy","dci_wid","idin"],"description":"none, a copy of the ID document in the restricted \"Wwft\" folder, a DCI/WID report, or iDIN (placeholder)."},"identificationDocumentId":{"type":"string","nullable":true,"format":"uuid"},"identificationReference":{"type":"string","nullable":true,"maxLength":200},"ubos":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200,"description":"Name of the ultimate beneficial owner (client data)."},"role":{"type":"string","enum":["owner","director","control","pseudo"],"description":"Ownership, director, other control, or pseudo-UBO."},"sharePercent":{"type":"integer","nullable":true,"minimum":0,"maximum":100,"description":"Share or control percentage."},"verified":{"type":"boolean","description":"Checked against the UBO register extract."}},"required":["name","role","sharePercent","verified"],"additionalProperties":false,"description":"One ultimate beneficial owner."},"maxItems":25,"description":"Replaces the UBO list."},"pepStatus":{"type":"string","enum":["unknown","no","yes"],"description":"Setting it stamps the date and the checking user."},"riskClass":{"type":"string","enum":["unset","low","normal","high"],"description":"Risk classification."},"sourceOfFunds":{"type":"string","nullable":true,"maxLength":2000},"reviewDueOn":{"type":"string","nullable":true,"format":"date"},"reviewed":{"type":"boolean","enum":[true],"description":"Record a periodic review now; without `reviewDueOn` the next review follows the risk class (high 1, normal 2, low 3 years)."}},"additionalProperties":false,"description":"Change the Wwft dossier (`wwft.dossier.update`). Fields that are absent stay unchanged."}}}},"responses":{"200":{"description":"The dossier.","content":{"application/json":{"schema":{"type":"object","properties":{"clientId":{"type":"string","format":"uuid"},"clientName":{"type":"string","nullable":true},"exists":{"type":"boolean","description":"false when nothing has been recorded yet (all fields at their defaults)."},"identificationMethod":{"type":"string","enum":["none","id_copy","dci_wid","idin"],"description":"none, a copy of the ID document in the restricted \"Wwft\" folder, a DCI/WID report, or iDIN (placeholder)."},"identificationDocumentId":{"type":"string","nullable":true,"format":"uuid","description":"The ID copy or report in an internal \"Wwft\" folder of one of the client's rooms."},"identificationReference":{"type":"string","nullable":true,"description":"Report number or note (client data)."},"identifiedAt":{"type":"string","nullable":true,"format":"date-time"},"ubos":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200,"description":"Name of the ultimate beneficial owner (client data)."},"role":{"type":"string","enum":["owner","director","control","pseudo"],"description":"Ownership, director, other control, or pseudo-UBO."},"sharePercent":{"type":"integer","nullable":true,"minimum":0,"maximum":100,"description":"Share or control percentage."},"verified":{"type":"boolean","description":"Checked against the UBO register extract."}},"required":["name","role","sharePercent","verified"],"additionalProperties":false,"description":"One ultimate beneficial owner."}},"pepStatus":{"type":"string","enum":["unknown","no","yes"],"description":"Manual PEP check result."},"pepCheckedAt":{"type":"string","nullable":true,"format":"date-time"},"pepCheckedBy":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","nullable":true}},"required":["id","displayName"]},"riskClass":{"type":"string","enum":["unset","low","normal","high"],"description":"Risk classification."},"sourceOfFunds":{"type":"string","nullable":true,"description":"Source-of-funds notes (client data)."},"reviewDueOn":{"type":"string","nullable":true,"format":"date"},"lastReviewedAt":{"type":"string","nullable":true,"format":"date-time"},"relationshipEndedAt":{"type":"string","nullable":true,"format":"date-time"},"retentionUntil":{"type":"string","nullable":true,"format":"date","description":"End of the Wwft retention (class wwft_cdd, from the relationship end); null while the relationship runs."},"openMatterCount":{"type":"integer","minimum":0},"status":{"type":"string","enum":["complete","incomplete","review_due","ended"],"description":"complete, incomplete (see `missing`), review due, or the relationship has ended (retention running)."},"missing":{"type":"array","items":{"type":"string","enum":["identification","ubo","pep_check","risk_class","source_of_funds"]}},"updatedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["clientId","clientName","exists","identificationMethod","identificationDocumentId","identificationReference","identifiedAt","ubos","pepStatus","pepCheckedAt","pepCheckedBy","riskClass","sourceOfFunds","reviewDueOn","lastReviewedAt","relationshipEndedAt","retentionUntil","openMatterCount","status","missing","updatedAt"],"description":"The Wwft client-due-diligence record of one client."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"A firm user without a Wwft role (firm_admin, compliance, lawyer, adviser, legal_assistant), or a guest.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, node, group or client; no access; cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/clients/{clientId}/wwft/relationship-end":{"post":{"operationId":"endWwftRelationship","summary":"Record the end of the client relationship (starts the Wwft retention)","description":"`wwft.relationship.end` (step-up). Records the `relationship_end` retention trigger on the client (ADR-0035, class wwft_cdd, 5 years by default) and dates the dossier. 409 `CONFLICT` while the client has open matters or when the end is already recorded. Writes `retention.trigger_recorded`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Client id."},"required":true,"description":"Client id.","name":"clientId","in":"path"}],"responses":{"200":{"description":"The dossier.","content":{"application/json":{"schema":{"type":"object","properties":{"clientId":{"type":"string","format":"uuid"},"clientName":{"type":"string","nullable":true},"exists":{"type":"boolean","description":"false when nothing has been recorded yet (all fields at their defaults)."},"identificationMethod":{"type":"string","enum":["none","id_copy","dci_wid","idin"],"description":"none, a copy of the ID document in the restricted \"Wwft\" folder, a DCI/WID report, or iDIN (placeholder)."},"identificationDocumentId":{"type":"string","nullable":true,"format":"uuid","description":"The ID copy or report in an internal \"Wwft\" folder of one of the client's rooms."},"identificationReference":{"type":"string","nullable":true,"description":"Report number or note (client data)."},"identifiedAt":{"type":"string","nullable":true,"format":"date-time"},"ubos":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200,"description":"Name of the ultimate beneficial owner (client data)."},"role":{"type":"string","enum":["owner","director","control","pseudo"],"description":"Ownership, director, other control, or pseudo-UBO."},"sharePercent":{"type":"integer","nullable":true,"minimum":0,"maximum":100,"description":"Share or control percentage."},"verified":{"type":"boolean","description":"Checked against the UBO register extract."}},"required":["name","role","sharePercent","verified"],"additionalProperties":false,"description":"One ultimate beneficial owner."}},"pepStatus":{"type":"string","enum":["unknown","no","yes"],"description":"Manual PEP check result."},"pepCheckedAt":{"type":"string","nullable":true,"format":"date-time"},"pepCheckedBy":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","nullable":true}},"required":["id","displayName"]},"riskClass":{"type":"string","enum":["unset","low","normal","high"],"description":"Risk classification."},"sourceOfFunds":{"type":"string","nullable":true,"description":"Source-of-funds notes (client data)."},"reviewDueOn":{"type":"string","nullable":true,"format":"date"},"lastReviewedAt":{"type":"string","nullable":true,"format":"date-time"},"relationshipEndedAt":{"type":"string","nullable":true,"format":"date-time"},"retentionUntil":{"type":"string","nullable":true,"format":"date","description":"End of the Wwft retention (class wwft_cdd, from the relationship end); null while the relationship runs."},"openMatterCount":{"type":"integer","minimum":0},"status":{"type":"string","enum":["complete","incomplete","review_due","ended"],"description":"complete, incomplete (see `missing`), review due, or the relationship has ended (retention running)."},"missing":{"type":"array","items":{"type":"string","enum":["identification","ubo","pep_check","risk_class","source_of_funds"]}},"updatedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["clientId","clientName","exists","identificationMethod","identificationDocumentId","identificationReference","identifiedAt","ubos","pepStatus","pepCheckedAt","pepCheckedBy","riskClass","sourceOfFunds","reviewDueOn","lastReviewedAt","relationshipEndedAt","retentionUntil","openMatterCount","status","missing","updatedAt"],"description":"The Wwft client-due-diligence record of one client."}}}},"401":{"description":"`STEP_UP_REQUIRED`: fresh authentication is required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"A firm user without a Wwft role (firm_admin, compliance, lawyer, adviser, legal_assistant), or a guest.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, node, group or client; no access; cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"`CONFLICT`: open matters, or already ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/wwft/overview":{"get":{"operationId":"getWwftOverview","summary":"Wwft overview of all clients (Beheer)","description":"`wwft.overview.read` (firm_admin, compliance). Writes `wwft_overview.read` (count only).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"The overview.","content":{"application/json":{"schema":{"type":"object","properties":{"clients":{"type":"array","items":{"type":"object","properties":{"clientId":{"type":"string","format":"uuid"},"clientName":{"type":"string","nullable":true},"status":{"type":"string","enum":["complete","incomplete","review_due","ended"],"description":"complete, incomplete (see `missing`), review due, or the relationship has ended (retention running)."},"missing":{"type":"array","items":{"type":"string","enum":["identification","ubo","pep_check","risk_class","source_of_funds"]}},"riskClass":{"type":"string","enum":["unset","low","normal","high"],"description":"Risk classification."},"pepStatus":{"type":"string","enum":["unknown","no","yes"],"description":"Manual PEP check result."},"reviewDueOn":{"type":"string","nullable":true,"format":"date"},"relationshipEndedAt":{"type":"string","nullable":true,"format":"date-time"},"retentionUntil":{"type":"string","nullable":true,"format":"date"},"openMatterCount":{"type":"integer","minimum":0}},"required":["clientId","clientName","status","missing","riskClass","pepStatus","reviewDueOn","relationshipEndedAt","retentionUntil","openMatterCount"],"description":"One client in the Wwft overview."}},"counts":{"type":"object","properties":{"complete":{"type":"integer"},"incomplete":{"type":"integer"},"reviewDue":{"type":"integer"},"ended":{"type":"integer"}},"required":["complete","incomplete","reviewDue","ended"]}},"required":["clients","counts"],"description":"Beheer > Wwft-overzicht."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Visible, but the caller lacks the level or role.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, node, group or client; no access; cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"AUDIT_UNAVAILABLE: the audit event could not be written; nothing was served (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/wwft/overview/export":{"get":{"operationId":"exportWwftOverview","summary":"Export the Wwft overview as XLSX (evidence for the deken or the BFT)","description":"`wwft.overview.export` (firm_admin, compliance). Writes `wwft_overview.exported` (count only) before the first byte.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","enum":["nl","en"],"description":"Language of the sheet; default nl."},"required":false,"description":"Language of the sheet; default nl.","name":"locale","in":"query"}],"responses":{"200":{"description":"The workbook.","content":{"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string"}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Visible, but the caller lacks the level or role.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, node, group or client; no access; cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"AUDIT_UNAVAILABLE: the audit event could not be written; nothing was served (fail closed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/matters/{matterId}/close":{"post":{"operationId":"closeMatter","summary":"Close a matter","description":"`matter.close` (firm_admin, compliance or the responsible lawyer). When it was the client's last open matter the database records the client's `relationship_end` retention trigger, so the Wwft retention (wwft_cdd) starts. Closing cascades to the matter's rooms in the same transaction (T-261004-d3da, MAT-11): every `active` or `frozen` room moves to `closed` through the `room_closed` trigger path. 409 `CONFLICT` when already closed. Writes `matter.closed` plus one `room.state_changed` per cascaded room.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Matter id."},"required":true,"description":"Matter id.","name":"matterId","in":"path"}],"responses":{"200":{"description":"Closed.","content":{"application/json":{"schema":{"type":"object","properties":{"matterId":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["closed"]},"relationshipEnded":{"type":"boolean","description":"true when this was the client's last open matter: the Wwft retention (wwft_cdd) started."},"roomsClosed":{"type":"integer","minimum":0,"description":"Rooms of this matter closed by the cascade in the same transaction (MAT-11)."}},"required":["matterId","status","relationshipEnded","roomsClosed"],"description":"A closed matter."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Visible, but the caller lacks the level or role.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, node, group or client; no access; cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"`CONFLICT`: already closed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/sheets":{"get":{"operationId":"listDocumentSheets","summary":"List the sheets of a spreadsheet document (Excel viewer)","description":"Requires `node.read` and `document.view` on the document (firm user or guest). Answers from the worker-extracted `sheet_json` derivative of the current version; 404 while there is none (the viewer then falls back to page images). 403 `DOWNLOAD_MODE_RESTRICTED` for a PDF-only caller: the cell grid is the source, they see the page images. Not audited (like the page count of the document read); every served sheet window is.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"}],"responses":{"200":{"description":"The sheets.","content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid"},"versionId":{"type":"string","format":"uuid"},"sheets":{"type":"array","items":{"type":"object","properties":{"sheetNo":{"type":"integer","minimum":1},"name":{"type":"string","description":"Sheet name (client content)."},"rowCount":{"type":"integer","minimum":0,"description":"Rows the sheet uses (before the stored cap)."},"colCount":{"type":"integer","minimum":0},"truncatedRows":{"type":"boolean","description":"Rows beyond the stored cap exist; download the file for them."},"truncatedCols":{"type":"boolean"}},"required":["sheetNo","name","rowCount","colCount","truncatedRows","truncatedCols"],"description":"One visible sheet of the workbook."},"minItems":1},"truncatedSheets":{"type":"boolean"},"formulas":{"type":"boolean","description":"Formula text is included on cells (firm users with download rights only)."}},"required":["documentId","versionId","sheets","truncatedSheets","formulas"],"description":"The sheets of a spreadsheet document."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"PDF-only caller (`DOWNLOAD_MODE_RESTRICTED`).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown document, no view right, not a spreadsheet or no cell extraction yet (including cross-tenant, PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/sheets/{sheetNo}":{"get":{"operationId":"getDocumentSheet","summary":"One window of rows of a sheet, with the forensic watermark","description":"Same access as `listDocumentSheets` (403 `DOWNLOAD_MODE_RESTRICTED` for a PDF-only caller). Cell values as the workbook stored them (no formula is evaluated); formula text only for firm users with `document.download`. Writes `document.sheet_viewed` (version id, sheet number, first row, forensic id) before the first byte; 503 when that fails. Rate limited on the viewer bucket. Cache-Control: no-store.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"},{"schema":{"type":"string","pattern":"^[1-9][0-9]{0,2}$","description":"1-based sheet number (the order of the visible sheets)."},"required":true,"description":"1-based sheet number (the order of the visible sheets).","name":"sheetNo","in":"path"},{"schema":{"type":"string","pattern":"^[0-9]{1,7}$","description":"First row of the window (0-based, default 0)."},"required":false,"description":"First row of the window (0-based, default 0).","name":"offset","in":"query"},{"schema":{"type":"string","pattern":"^[1-9][0-9]{0,3}$","description":"Rows in the window (default 500, at most 2000)."},"required":false,"description":"Rows in the window (default 500, at most 2000).","name":"limit","in":"query"}],"responses":{"200":{"description":"The window.","content":{"application/json":{"schema":{"type":"object","properties":{"sheetNo":{"type":"integer","minimum":1},"name":{"type":"string"},"rowCount":{"type":"integer","minimum":0,"description":"Rows available in the viewer (capped)."},"colCount":{"type":"integer","minimum":0},"offset":{"type":"integer","minimum":0},"limit":{"type":"integer","minimum":1},"hasMore":{"type":"boolean","description":"More rows follow this window."},"truncatedRows":{"type":"boolean"},"truncatedCols":{"type":"boolean"},"colWidths":{"type":"array","items":{"type":"number","nullable":true}},"merges":{"type":"array","items":{"type":"array","items":{"type":"integer"},"minItems":4,"maxItems":4}},"frozenRows":{"type":"integer","minimum":0},"frozenCols":{"type":"integer","minimum":0},"cells":{"type":"array","items":{"type":"object","properties":{"r":{"type":"integer","minimum":0},"c":{"type":"integer","minimum":0},"t":{"type":"string","enum":["n","s","b","d","e"],"description":"number, string, boolean, date (ISO 8601 in v) or error."},"v":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"}]},"z":{"type":"string","description":"Excel number format code, when not General."},"f":{"type":"string","description":"Formula text, only when `formulas` is true."}},"required":["r","c","t","v"],"description":"One non-empty cell."}},"watermark":{"type":"object","properties":{"lines":{"type":"array","items":{"type":"string"},"description":"Name, e-mail, UTC minute and forensic id, drawn over the grid."},"forensicId":{"type":"string","pattern":"^[A-Z][A-Z2-7]{7}$"}},"required":["lines","forensicId"],"description":"The forensic watermark of this view (ADR-0011 D12), also written to the audit event."}},"required":["sheetNo","name","rowCount","colCount","offset","limit","hasMore","truncatedRows","truncatedCols","colWidths","merges","frozenRows","frozenCols","cells","watermark"],"description":"A window of rows of one sheet."}}}},"400":{"description":"Invalid sheet number or window.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"PDF-only caller (`DOWNLOAD_MODE_RESTRICTED`).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown document, no view right, not a spreadsheet or no cell extraction yet (including cross-tenant, PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limited (code RATE_LIMITED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"The audit event could not be written (AUDIT_UNAVAILABLE).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/report-exports":{"post":{"operationId":"createReportExport","summary":"Ask for a report file (report catalogue)","description":"Firm users only. The cross-room reports (`activity_per_room`, `access_per_person`, `open_requests`) need `audit.read_tenant` (firm admins, compliance); `index_history` needs `audit.read_room` on `roomId`. Otherwise 404. The worker builds the XLSX/CSV, encrypts it (tenant key, or the room key for a room report) and records `export.created`. At most three unfinished exports per person (429).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["activity_per_room","access_per_person","open_requests","index_history"],"description":"Report kind."},"format":{"type":"string","enum":["xlsx","csv"],"description":"Default xlsx."},"locale":{"type":"string","enum":["nl","en"],"description":"Column headings language (default nl)."},"from":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Period start (default 30 days ago)."},"to":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Period end, inclusive (default today)."},"roomId":{"type":"string","format":"uuid","description":"Required for index_history."},"principalId":{"type":"string","format":"uuid","description":"Required for access_per_person."}},"required":["kind"],"additionalProperties":false,"description":"Ask for one report file."}}}},"responses":{"202":{"description":"Queued.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["activity_per_room","access_per_person","open_requests","index_history"],"description":"Report kind."},"format":{"type":"string","enum":["xlsx","csv"],"description":"File format."},"status":{"type":"string","enum":["queued","building","ready","failed"]},"roomId":{"type":"string","nullable":true,"format":"uuid"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"rowCount":{"type":"integer","nullable":true,"minimum":0},"sizeBytes":{"type":"integer","nullable":true,"minimum":0},"failureCode":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","format":"date-time"}},"required":["id","kind","format","status","roomId","from","to","rowCount","sizeBytes","failureCode","createdAt","completedAt","expiresAt"],"description":"One report export of the caller (ids, codes and counts only)."}}}},"400":{"description":"Invalid body (missing room or person, period too long).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"No right to this report (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Too many unfinished exports.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"get":{"operationId":"listReportExports","summary":"The caller’s report exports of the last 7 days","description":"Firm users only; a guest gets 404. Only the caller’s own exports, newest first (at most 50). `truncated` is true when the 7-day window holds more exports than were returned, so a capped list is never mistaken for the whole history.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"The exports with their completeness signal.","content":{"application/json":{"schema":{"type":"object","properties":{"exports":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["activity_per_room","access_per_person","open_requests","index_history"],"description":"Report kind."},"format":{"type":"string","enum":["xlsx","csv"],"description":"File format."},"status":{"type":"string","enum":["queued","building","ready","failed"]},"roomId":{"type":"string","nullable":true,"format":"uuid"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"rowCount":{"type":"integer","nullable":true,"minimum":0},"sizeBytes":{"type":"integer","nullable":true,"minimum":0},"failureCode":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","format":"date-time"}},"required":["id","kind","format","status","roomId","from","to","rowCount","sizeBytes","failureCode","createdAt","completedAt","expiresAt"],"description":"One report export of the caller (ids, codes and counts only)."},"description":"The caller’s own report exports, newest first."},"truncated":{"type":"boolean","description":"True when more exports exist than were returned (the list is partial)."}},"required":["exports","truncated"],"description":"The caller’s report exports of the last 7 days, newest first."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not a firm user of the tenant.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/report-exports/{exportId}":{"get":{"operationId":"getReportExport","summary":"One of the caller’s report exports","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"exportId","in":"path"}],"responses":{"200":{"description":"The export.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["activity_per_room","access_per_person","open_requests","index_history"],"description":"Report kind."},"format":{"type":"string","enum":["xlsx","csv"],"description":"File format."},"status":{"type":"string","enum":["queued","building","ready","failed"]},"roomId":{"type":"string","nullable":true,"format":"uuid"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"rowCount":{"type":"integer","nullable":true,"minimum":0},"sizeBytes":{"type":"integer","nullable":true,"minimum":0},"failureCode":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","format":"date-time"}},"required":["id","kind","format","status","roomId","from","to","rowCount","sizeBytes","failureCode","createdAt","completedAt","expiresAt"],"description":"One report export of the caller (ids, codes and counts only)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown export, another person’s export, or the caller no longer holds the report’s right (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/report-exports/{exportId}/download":{"get":{"operationId":"downloadReportExport","summary":"Download a built report file","description":"The requester only, after the report’s policy check again. Writes `export.downloaded` before the first byte (503 when that fails). 409 while building, 410 after 7 days.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"exportId","in":"path"}],"responses":{"200":{"description":"The file.","content":{"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string"}},"text/csv":{"schema":{"type":"string"}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown export, another person’s export, or the caller no longer holds the report’s right (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Not ready (DOWNLOAD_NOT_READY).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"410":{"description":"Expired (DOWNLOAD_EXPIRED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"The audit event could not be written (AUDIT_UNAVAILABLE).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/signing-requests":{"get":{"operationId":"listDocumentSigningRequests","summary":"Read the signing requests of a document","description":"`signing.read` (`view`, firm users only) on the document node. Newest first with a keyset cursor and every signer (name, address, status, verification) and the evidence hash of a completed request; `truncated` is true when the cap holds more requests than were returned, so a capped list is never mistaken for the whole list. Guests get 404.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"},{"schema":{"type":"string","maxLength":512,"description":"Opaque keyset cursor from the previous page; omit it for the newest page."},"required":false,"description":"Opaque keyset cursor from the previous page; omit it for the newest page.","name":"cursor","in":"query"}],"responses":{"200":{"description":"The requests with an explicit partial signal.","content":{"application/json":{"schema":{"type":"object","properties":{"requests":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"sourceVersionId":{"type":"string","format":"uuid"},"sourceVersionNo":{"type":"integer","nullable":true,"minimum":1},"resultVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The signed version, once completed."},"resultVersionNo":{"type":"integer","nullable":true,"minimum":1},"provider":{"type":"string","enum":["local_sink","validsign"],"description":"The provider that handles the envelope (ADR-0055 D2)."},"level":{"type":"string","enum":["ses","aes","qes"],"description":"Signature level (eIDAS): simple, advanced or qualified. `local_sink` records SES/AES only."},"status":{"type":"string","enum":["pending","completed","cancelled","expired","failed"],"description":"Request status."},"message":{"type":"string","nullable":true},"expiresAt":{"type":"string","format":"date-time"},"evidenceSha256":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"SHA-256 (hex) of the evidence file, once completed; also on the evidence page of the signed PDF."},"createdBy":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","nullable":true}},"required":["id","displayName"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"cancelledAt":{"type":"string","nullable":true,"format":"date-time"},"signers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":1,"description":"Signing order (1 first)."},"kind":{"type":"string","enum":["user","guest"],"description":"A firm user or a code-based guest of the room."},"displayName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true,"description":"Firm view only; never returned to other signers."},"status":{"type":"string","enum":["pending","signed","declined"],"description":"Signer status."},"signedAt":{"type":"string","nullable":true,"format":"date-time"},"verification":{"type":"string","nullable":true,"enum":["email_code","email_sms_code","password_totp","provider",null],"description":"How the signer proved its identity at signing time (evidence)."}},"required":["id","position","kind","displayName","email","status","signedAt","verification"],"additionalProperties":false,"description":"One signer as the firm sees it."}}},"required":["id","documentId","sourceVersionId","sourceVersionNo","resultVersionId","resultVersionNo","provider","level","status","message","expiresAt","evidenceSha256","createdBy","createdAt","completedAt","cancelledAt","signers"],"additionalProperties":false,"description":"A signing request with its signers (firm view)."},"description":"Newest first."},"truncated":{"type":"boolean","default":false,"description":"True when more signing requests exist than were returned (the list is partial). The server always sends an explicit value; the default keeps older bare payloads parseable as complete."},"nextCursor":{"type":"string","nullable":true,"default":null,"description":"Opaque cursor for the next (older) page; null on the last page."}},"required":["requests"],"additionalProperties":false,"description":"The signing requests of a document, newest first with an explicit partial signal."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or document, no access, a guest, or cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"post":{"operationId":"createSigningRequest","summary":"Offer the current version for signature","description":"`signing.request` (`edit`, firm users only) on the document node. Only a PDF version can be signed (409 `PDF_UNAVAILABLE` otherwise). Creates the request and its signers in signing order: a signer with `userId` (a firm user who is a member of the room) signs with its own session; every other signer becomes (or already is) a code-based guest of the room, member of a client group with `view` on this document only, with the mobile number recorded for the SMS second factor (ADR-0026). Each signer gets an e-mail with its link. Hands the envelope to the configured provider (`local_sink` locally; 409 `SIGNING_PROVIDER_UNAVAILABLE` when the provider cannot run here). Writes `signing.requested` (ids, level and counts only). 409 `CONFLICT` when `versionId` is not the current available version, 409 `SIGNING_NOT_PENDING` when a pending request already exists for the document.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","description":"The current version the signers sign (409 `CONFLICT` when superseded)."},"level":{"type":"string","enum":["ses","aes","qes"],"description":"Signature level (eIDAS): simple, advanced or qualified. `local_sink` records SES/AES only."},"message":{"type":"string","nullable":true,"minLength":1,"maxLength":2000,"description":"Note to the signers."},"expiresInDays":{"type":"integer","minimum":1,"maximum":90,"description":"Days until the request expires."},"signers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120,"description":"Display name of the signer (client data)."},"email":{"type":"string","maxLength":254,"description":"Address the signing link goes to."},"phone":{"type":"string","nullable":true,"pattern":"^\\+[1-9][0-9]{7,14}$","description":"Guest signers: the SMS number (ADR-0026); ignored for firm users."},"userId":{"type":"string","nullable":true,"format":"uuid","description":"A firm user of the tenant (a member of the room) who signs with its own session; null for a guest."}},"required":["name","email"],"additionalProperties":false,"description":"One signer, in signing order."},"minItems":1,"maxItems":10,"description":"Signers in signing order."}},"required":["versionId","level","message","expiresInDays","signers"],"additionalProperties":false,"description":"Offer a document for signature."}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"sourceVersionId":{"type":"string","format":"uuid"},"sourceVersionNo":{"type":"integer","nullable":true,"minimum":1},"resultVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The signed version, once completed."},"resultVersionNo":{"type":"integer","nullable":true,"minimum":1},"provider":{"type":"string","enum":["local_sink","validsign"],"description":"The provider that handles the envelope (ADR-0055 D2)."},"level":{"type":"string","enum":["ses","aes","qes"],"description":"Signature level (eIDAS): simple, advanced or qualified. `local_sink` records SES/AES only."},"status":{"type":"string","enum":["pending","completed","cancelled","expired","failed"],"description":"Request status."},"message":{"type":"string","nullable":true},"expiresAt":{"type":"string","format":"date-time"},"evidenceSha256":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"SHA-256 (hex) of the evidence file, once completed; also on the evidence page of the signed PDF."},"createdBy":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","nullable":true}},"required":["id","displayName"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"cancelledAt":{"type":"string","nullable":true,"format":"date-time"},"signers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":1,"description":"Signing order (1 first)."},"kind":{"type":"string","enum":["user","guest"],"description":"A firm user or a code-based guest of the room."},"displayName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true,"description":"Firm view only; never returned to other signers."},"status":{"type":"string","enum":["pending","signed","declined"],"description":"Signer status."},"signedAt":{"type":"string","nullable":true,"format":"date-time"},"verification":{"type":"string","nullable":true,"enum":["email_code","email_sms_code","password_totp","provider",null],"description":"How the signer proved its identity at signing time (evidence)."}},"required":["id","position","kind","displayName","email","status","signedAt","verification"],"additionalProperties":false,"description":"One signer as the firm sees it."}}},"required":["id","documentId","sourceVersionId","sourceVersionNo","resultVersionId","resultVersionNo","provider","level","status","message","expiresAt","evidenceSha256","createdBy","createdAt","completedAt","cancelledAt","signers"],"additionalProperties":false,"description":"A signing request with its signers (firm view)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"`STEP_UP_REQUIRED`: stronger authentication is required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"The caller sees the document but lacks the `edit` level (or is not a firm user).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or document, no access, a guest, or cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"`CONFLICT`, `SIGNING_NOT_PENDING`, `SIGNING_PROVIDER_UNAVAILABLE` or `READ_ONLY`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/signing-requests/{requestId}/cancel":{"post":{"operationId":"cancelSigningRequest","summary":"Cancel a pending signing request","description":"`signing.cancel` (`edit`, firm users only) on the document node of the request. Cancels the envelope at the provider, marks the request cancelled and writes `signing.cancelled`. 409 `SIGNING_NOT_PENDING` when it is not pending.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Signing request id."},"required":true,"description":"Signing request id.","name":"requestId","in":"path"}],"responses":{"200":{"description":"Cancelled.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"sourceVersionId":{"type":"string","format":"uuid"},"sourceVersionNo":{"type":"integer","nullable":true,"minimum":1},"resultVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The signed version, once completed."},"resultVersionNo":{"type":"integer","nullable":true,"minimum":1},"provider":{"type":"string","enum":["local_sink","validsign"],"description":"The provider that handles the envelope (ADR-0055 D2)."},"level":{"type":"string","enum":["ses","aes","qes"],"description":"Signature level (eIDAS): simple, advanced or qualified. `local_sink` records SES/AES only."},"status":{"type":"string","enum":["pending","completed","cancelled","expired","failed"],"description":"Request status."},"message":{"type":"string","nullable":true},"expiresAt":{"type":"string","format":"date-time"},"evidenceSha256":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$","description":"SHA-256 (hex) of the evidence file, once completed; also on the evidence page of the signed PDF."},"createdBy":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string","nullable":true}},"required":["id","displayName"],"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"cancelledAt":{"type":"string","nullable":true,"format":"date-time"},"signers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":1,"description":"Signing order (1 first)."},"kind":{"type":"string","enum":["user","guest"],"description":"A firm user or a code-based guest of the room."},"displayName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true,"description":"Firm view only; never returned to other signers."},"status":{"type":"string","enum":["pending","signed","declined"],"description":"Signer status."},"signedAt":{"type":"string","nullable":true,"format":"date-time"},"verification":{"type":"string","nullable":true,"enum":["email_code","email_sms_code","password_totp","provider",null],"description":"How the signer proved its identity at signing time (evidence)."}},"required":["id","position","kind","displayName","email","status","signedAt","verification"],"additionalProperties":false,"description":"One signer as the firm sees it."}}},"required":["id","documentId","sourceVersionId","sourceVersionNo","resultVersionId","resultVersionNo","provider","level","status","message","expiresAt","evidenceSha256","createdBy","createdAt","completedAt","cancelledAt","signers"],"additionalProperties":false,"description":"A signing request with its signers (firm view)."}}}},"401":{"description":"`STEP_UP_REQUIRED`: stronger authentication is required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"The caller sees the document but lacks the `edit` level (or is not a firm user).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or document, no access, a guest, or cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"`SIGNING_NOT_PENDING` or `READ_ONLY`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/signing-templates":{"get":{"operationId":"listSigningTemplates","summary":"The firm signing-document library","description":"`signing_template.read` (any firm role). The synthetic sample documents a signing request can start from: opdrachtbevestiging, dienstverleningsdocument, mediationovereenkomst. Titles follow `?locale`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","enum":["nl","en"]},"required":false,"name":"locale","in":"query"}],"responses":{"200":{"description":"The library.","content":{"application/json":{"schema":{"type":"object","properties":{"templates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9-]{1,40}$","description":"Template id (stable code)."},"kind":{"type":"string","enum":["engagement_letter","service_document","mediation_agreement"],"description":"Template kind: opdrachtbevestiging, dienstverleningsdocument, mediationovereenkomst."},"title":{"type":"string","description":"Title in the requested locale."},"description":{"type":"string","description":"One line about when the firm uses it."},"defaultLevel":{"type":"string","enum":["ses","aes","qes"],"description":"Signature level (eIDAS): simple, advanced or qualified. `local_sink` records SES/AES only."},"pageCount":{"type":"integer","minimum":1}},"required":["id","kind","title","description","defaultLevel","pageCount"],"additionalProperties":false,"description":"One entry of the firm signing-document library."}}},"required":["templates"],"additionalProperties":false,"description":"The firm signing-document library."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, cross-tenant or a guest (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/signing-templates/{templateId}":{"post":{"operationId":"instantiateSigningTemplate","summary":"Create a library document in a room","description":"`document.upload` on the target folder (or the room root). Renders the template as a PDF with the given (synthetic) client name and subject and stores it through the ordinary upload path (encrypted, scan pipeline, `document_version.uploaded`). The firm then offers it for signature with `createSigningRequest`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","pattern":"^[a-z][a-z0-9-]{1,40}$"},"required":true,"name":"templateId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"folderId":{"type":"string","nullable":true,"format":"uuid","description":"Target folder; null is the room root."},"clientName":{"type":"string","minLength":1,"maxLength":120},"subject":{"type":"string","minLength":1,"maxLength":200,"description":"The matter or product the document is about."},"locale":{"type":"string","enum":["nl","en"],"default":"nl"}},"required":["folderId","clientName","subject"],"additionalProperties":false,"description":"Create the template document in a room, ready to be offered for signature."}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"type":"object","properties":{"nodeId":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"versionId":{"type":"string","format":"uuid"},"title":{"type":"string"}},"required":["nodeId","documentId","versionId","title"],"additionalProperties":false,"description":"The document created from a template (version 1, scan pending)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"`STEP_UP_REQUIRED`: stronger authentication is required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"No `upload` on the folder.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, folder or template; a guest (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"`READ_ONLY`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"413":{"description":"`STORAGE_POOL_EXHAUSTED`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/sign/{token}":{"get":{"operationId":"getSigningTask","summary":"The signing task behind a link","description":"`signing.signer.read` on the room, plus the check that the session principal is the signer of the link. A guest needs the guest e-mail-code session of the address the link was sent to (401 `EMAIL_CODE_REQUIRED` otherwise) and, before the pages can be viewed, the SMS second factor (`STEP_UP_REQUIRED`, ADR-0026); a firm user its normal session. Returns the request, the own signer row and the status of the other signers (names, never addresses). The pages are read through the ordinary viewer (`getDocumentPage`), which decides `document.view` on the node the signer was given `view` on.","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"The link token from the signing e-mail (32 random bytes, base64url). Never a credential."},"required":true,"description":"The link token from the signing e-mail (32 random bytes, base64url). Never a credential.","name":"token","in":"path"}],"responses":{"200":{"description":"The task.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid"},"tenantId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"documentTitle":{"type":"string","nullable":true},"firmName":{"type":"string"},"level":{"type":"string","enum":["ses","aes","qes"],"description":"Signature level (eIDAS): simple, advanced or qualified. `local_sink` records SES/AES only."},"status":{"type":"string","enum":["pending","completed","cancelled","expired","failed"],"description":"Request status."},"message":{"type":"string","nullable":true},"expiresAt":{"type":"string","format":"date-time"},"pageCount":{"type":"integer","minimum":0,"description":"Pages of the version to sign (0 while rendering)."},"you":{"type":"object","properties":{"signerId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":1},"displayName":{"type":"string","nullable":true},"status":{"type":"string","enum":["pending","signed","declined"],"description":"Signer status."},"signedAt":{"type":"string","nullable":true,"format":"date-time"},"yourTurn":{"type":"boolean"}},"required":["signerId","position","displayName","status","signedAt","yourTurn"],"additionalProperties":false},"others":{"type":"array","items":{"type":"object","properties":{"position":{"type":"integer","minimum":1},"displayName":{"type":"string","nullable":true},"status":{"type":"string","enum":["pending","signed","declined"],"description":"Signer status."}},"required":["position","displayName","status"],"additionalProperties":false}},"signedVersionNo":{"type":"integer","nullable":true,"minimum":1,"description":"The signed version, once completed."},"evidenceSha256":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$"}},"required":["requestId","tenantId","roomId","documentId","documentTitle","firmName","level","status","message","expiresAt","pageCount","you","others","signedVersionNo","evidenceSha256"],"additionalProperties":false,"description":"What a signer sees: the request, its own row and the status of the other signers (no addresses)."}}}},"401":{"description":"`UNAUTHENTICATED`, `EMAIL_CODE_REQUIRED` or `STEP_UP_REQUIRED`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown, expired or revoked link, or not this signer.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/sign/{token}/sign":{"post":{"operationId":"signSigningTask","summary":"Sign the document","description":"`signing.sign` on the room (same session rules as `getSigningTask`). Records the signature (typed name, time, client IP, verification used) and writes `signing.signed` (ids and the verification code only). When this was the last signer, the signed PDF is built (the source plus a signature page and an evidence page with the SHA-256 of the source and of the evidence file), stored as a new version of the document (`reason = signed`), the evidence JSON is stored encrypted as a `signing_evidence` derivative, `signing.completed` is written and the requester is notified. 409 `SIGNING_NOT_PENDING` when the request is no longer pending or this signer already signed, `SIGNING_NOT_YOUR_TURN` while an earlier signer has not signed.","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"The link token from the signing e-mail (32 random bytes, base64url). Never a credential."},"required":true,"description":"The link token from the signing e-mail (32 random bytes, base64url). Never a credential.","name":"token","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"signatureName":{"type":"string","minLength":1,"maxLength":120,"description":"The name the signer typed as its signature."},"consent":{"type":"boolean","enum":[true],"description":"The signer agreed to sign electronically and read the document."}},"required":["signatureName","consent"],"additionalProperties":false,"description":"Sign the document."}}}},"responses":{"200":{"description":"Signed.","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid"},"tenantId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"documentTitle":{"type":"string","nullable":true},"firmName":{"type":"string"},"level":{"type":"string","enum":["ses","aes","qes"],"description":"Signature level (eIDAS): simple, advanced or qualified. `local_sink` records SES/AES only."},"status":{"type":"string","enum":["pending","completed","cancelled","expired","failed"],"description":"Request status."},"message":{"type":"string","nullable":true},"expiresAt":{"type":"string","format":"date-time"},"pageCount":{"type":"integer","minimum":0,"description":"Pages of the version to sign (0 while rendering)."},"you":{"type":"object","properties":{"signerId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":1},"displayName":{"type":"string","nullable":true},"status":{"type":"string","enum":["pending","signed","declined"],"description":"Signer status."},"signedAt":{"type":"string","nullable":true,"format":"date-time"},"yourTurn":{"type":"boolean"}},"required":["signerId","position","displayName","status","signedAt","yourTurn"],"additionalProperties":false},"others":{"type":"array","items":{"type":"object","properties":{"position":{"type":"integer","minimum":1},"displayName":{"type":"string","nullable":true},"status":{"type":"string","enum":["pending","signed","declined"],"description":"Signer status."}},"required":["position","displayName","status"],"additionalProperties":false}},"signedVersionNo":{"type":"integer","nullable":true,"minimum":1,"description":"The signed version, once completed."},"evidenceSha256":{"type":"string","nullable":true,"pattern":"^[0-9a-f]{64}$"}},"required":["requestId","tenantId","roomId","documentId","documentTitle","firmName","level","status","message","expiresAt","pageCount","you","others","signedVersionNo","evidenceSha256"],"additionalProperties":false,"description":"What a signer sees: the request, its own row and the status of the other signers (no addresses)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"`UNAUTHENTICATED`, `EMAIL_CODE_REQUIRED` or `STEP_UP_REQUIRED`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown, expired or revoked link, or not this signer.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"`SIGNING_NOT_PENDING`, `SIGNING_NOT_YOUR_TURN`, `PAGE_RENDERING` or `READ_ONLY`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/signing/webhooks/{provider}":{"post":{"operationId":"signingProviderWebhook","summary":"Provider status callback (external providers only)","description":"Public by design: admitted by the provider’s signed callback (HMAC over the raw body with the per-tenant webhook secret), never by a session. Refused with 404 unless that provider is configured (`DDR_SIGNING_PROVIDER`). The `validsign` adapter is a documented skeleton (not yet reviewed, no credentials): it verifies the signature and maps `PACKAGE_COMPLETE`/`PACKAGE_DECLINE`/`PACKAGE_EXPIRE` onto the request; nothing is written by the skeleton today.","parameters":[{"schema":{"type":"string","enum":["validsign"],"description":"The provider posting the callback."},"required":true,"description":"The provider posting the callback.","name":"provider","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":{"nullable":true}}}}},"responses":{"202":{"description":"Accepted."},"404":{"description":"Provider not configured or unknown.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/request-templates":{"post":{"operationId":"createRequestTemplate","summary":"Save a new firm request template","description":"Stores a template the firm built in the form builder (sections, sub-sections, items with icon, rich instructions, footnote and file rules). Organisation content, no client data. Instruction texts are reduced to the safe rich-text subset on the server; links stay only to the firm’s own hosts. Requires flow_template.manage (firm admin). Writes flow_template.created.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"description":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"profession":{"type":"string","enum":["legal","mortgage","notary","accounting","insolvency","general"],"description":"Profession a request template is made for."},"coverInstructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"participants":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Expected answer slot of this participant."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the participant (firm dossier vocabulary)."}},"required":["slot","label"],"description":"Expected participant of a firm template: answer slot plus display label."},"maxItems":10,"description":"Expected named slots of this template (roles only, no client data). Absent: an unrostered template where any well-formed slot assignment is accepted."},"sections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"items":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Instruction text in the safe rich-text subset (ADR-0048)."},"footnote":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"Defaults to `file`."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false},"maxItems":30}},"additionalProperties":false,"description":"Template answer rules (ADR-0048)."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named item icon of the request form (ADR-0048); the web maps it onto the icon set."},"required":{"type":"boolean"},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for; null or absent is shared."},"allowNotApplicable":{"type":"boolean","description":"Defaults to the inverse of `required`."},"allowMultiple":{"type":"boolean","description":"Defaults to true."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50},"targetPath":{"type":"string","nullable":true,"maxLength":200,"description":"Title of a top-level room folder."},"bsnAutoMask":{"type":"boolean","description":"Default of the item: burn every BSN out of a delivered file (ADR-0053)."},"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650,"description":"Default validity rule of the item in days (ADR-0053)."}},"required":["title","instructions","required","targetPath"],"description":"Template item."},"maxItems":100},"subsections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"items":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Instruction text in the safe rich-text subset (ADR-0048)."},"footnote":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"Defaults to `file`."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false},"maxItems":30}},"additionalProperties":false,"description":"Template answer rules (ADR-0048)."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named item icon of the request form (ADR-0048); the web maps it onto the icon set."},"required":{"type":"boolean"},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for; null or absent is shared."},"allowNotApplicable":{"type":"boolean","description":"Defaults to the inverse of `required`."},"allowMultiple":{"type":"boolean","description":"Defaults to true."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50},"targetPath":{"type":"string","nullable":true,"maxLength":200,"description":"Title of a top-level room folder."},"bsnAutoMask":{"type":"boolean","description":"Default of the item: burn every BSN out of a delivered file (ADR-0053)."},"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650,"description":"Default validity rule of the item in days (ADR-0053)."}},"required":["title","instructions","required","targetPath"],"description":"Template item."},"maxItems":100}},"required":["title","items"],"description":"Sub-section of a template (one level, ADR-0048)."},"maxItems":50},"repeat":{"type":"object","nullable":true,"properties":{"min":{"type":"integer","minimum":0,"maximum":10,"description":"Fewest repeats the client must add (0 = the group may be skipped)."},"max":{"type":"integer","minimum":1,"maximum":20,"description":"Most repeats the client may add."}},"required":["min","max"],"additionalProperties":false,"description":"Repeatable group (PRF-03): when present the section repeats min..max times (one block per repeat); absent or null is exactly one."}},"required":["title","items"],"description":"Section of a template, with optional sub-sections."},"minItems":1,"maxItems":50}},"required":["name","description","profession","coverInstructions","sections"],"additionalProperties":false,"description":"Save a firm template (organisation content, no client data). At least one item."}}}},"responses":{"201":{"description":"The saved template.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","maxLength":100},"name":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"description":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"profession":{"type":"string","enum":["legal","mortgage","notary","accounting","insolvency","general"],"description":"Profession a request template is made for."},"builtIn":{"type":"boolean","description":"False for a template the firm saved (editable)."},"coverInstructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Cover \"Instructies\" page of requests made from this template."},"participants":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Expected answer slot of this participant."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the participant (firm dossier vocabulary)."}},"required":["slot","label"],"description":"Expected participant of a firm template: answer slot plus display label."},"maxItems":10,"description":"Expected named slots of this template (roles only); absent on unrostered templates."},"updatedAt":{"type":"string","format":"date-time"},"contentHash":{"type":"string","pattern":"^[a-f0-9]{64}$","description":"Exact content fingerprint of a saved firm template (SP07). Required to pin a firm template reference in a versioned dossier pack; absent for read-only built-in starters, whose version is 1."},"sections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"items":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Instruction text in the safe rich-text subset (ADR-0048)."},"footnote":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"Defaults to `file`."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false},"maxItems":30}},"additionalProperties":false,"description":"Template answer rules (ADR-0048)."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named item icon of the request form (ADR-0048); the web maps it onto the icon set."},"required":{"type":"boolean"},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for; null or absent is shared."},"allowNotApplicable":{"type":"boolean","description":"Defaults to the inverse of `required`."},"allowMultiple":{"type":"boolean","description":"Defaults to true."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50},"targetPath":{"type":"string","nullable":true,"maxLength":200,"description":"Title of a top-level room folder."},"bsnAutoMask":{"type":"boolean","description":"Default of the item: burn every BSN out of a delivered file (ADR-0053)."},"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650,"description":"Default validity rule of the item in days (ADR-0053)."}},"required":["title","instructions","required","targetPath"],"description":"Template item."},"maxItems":100},"subsections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"items":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Instruction text in the safe rich-text subset (ADR-0048)."},"footnote":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"Defaults to `file`."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false},"maxItems":30}},"additionalProperties":false,"description":"Template answer rules (ADR-0048)."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named item icon of the request form (ADR-0048); the web maps it onto the icon set."},"required":{"type":"boolean"},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for; null or absent is shared."},"allowNotApplicable":{"type":"boolean","description":"Defaults to the inverse of `required`."},"allowMultiple":{"type":"boolean","description":"Defaults to true."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50},"targetPath":{"type":"string","nullable":true,"maxLength":200,"description":"Title of a top-level room folder."},"bsnAutoMask":{"type":"boolean","description":"Default of the item: burn every BSN out of a delivered file (ADR-0053)."},"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650,"description":"Default validity rule of the item in days (ADR-0053)."}},"required":["title","instructions","required","targetPath"],"description":"Template item."},"maxItems":100}},"required":["title","items"],"description":"Sub-section of a template (one level, ADR-0048)."},"maxItems":50},"repeat":{"type":"object","nullable":true,"properties":{"min":{"type":"integer","minimum":0,"maximum":10,"description":"Fewest repeats the client must add (0 = the group may be skipped)."},"max":{"type":"integer","minimum":1,"maximum":20,"description":"Most repeats the client may add."}},"required":["min","max"],"additionalProperties":false,"description":"Repeatable group (PRF-03): when present the section repeats min..max times (one block per repeat); absent or null is exactly one."}},"required":["title","items"],"description":"Section of a template, with optional sub-sections."}}},"required":["id","name","description","sections"],"description":"Request template (request-flow profile)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (not a firm admin).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/request-templates/{templateId}":{"put":{"operationId":"updateRequestTemplate","summary":"Replace a firm request template","description":"Full replace of a template the firm saved (built-in templates are read-only: 404). Requires flow_template.manage. Writes flow_template.updated.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","maxLength":100},"required":true,"name":"templateId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"description":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"profession":{"type":"string","enum":["legal","mortgage","notary","accounting","insolvency","general"],"description":"Profession a request template is made for."},"coverInstructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"participants":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Expected answer slot of this participant."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the participant (firm dossier vocabulary)."}},"required":["slot","label"],"description":"Expected participant of a firm template: answer slot plus display label."},"maxItems":10,"description":"Expected named slots of this template (roles only, no client data). Absent: an unrostered template where any well-formed slot assignment is accepted."},"sections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"items":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Instruction text in the safe rich-text subset (ADR-0048)."},"footnote":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"Defaults to `file`."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false},"maxItems":30}},"additionalProperties":false,"description":"Template answer rules (ADR-0048)."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named item icon of the request form (ADR-0048); the web maps it onto the icon set."},"required":{"type":"boolean"},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for; null or absent is shared."},"allowNotApplicable":{"type":"boolean","description":"Defaults to the inverse of `required`."},"allowMultiple":{"type":"boolean","description":"Defaults to true."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50},"targetPath":{"type":"string","nullable":true,"maxLength":200,"description":"Title of a top-level room folder."},"bsnAutoMask":{"type":"boolean","description":"Default of the item: burn every BSN out of a delivered file (ADR-0053)."},"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650,"description":"Default validity rule of the item in days (ADR-0053)."}},"required":["title","instructions","required","targetPath"],"description":"Template item."},"maxItems":100},"subsections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"items":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Instruction text in the safe rich-text subset (ADR-0048)."},"footnote":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"Defaults to `file`."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false},"maxItems":30}},"additionalProperties":false,"description":"Template answer rules (ADR-0048)."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named item icon of the request form (ADR-0048); the web maps it onto the icon set."},"required":{"type":"boolean"},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for; null or absent is shared."},"allowNotApplicable":{"type":"boolean","description":"Defaults to the inverse of `required`."},"allowMultiple":{"type":"boolean","description":"Defaults to true."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50},"targetPath":{"type":"string","nullable":true,"maxLength":200,"description":"Title of a top-level room folder."},"bsnAutoMask":{"type":"boolean","description":"Default of the item: burn every BSN out of a delivered file (ADR-0053)."},"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650,"description":"Default validity rule of the item in days (ADR-0053)."}},"required":["title","instructions","required","targetPath"],"description":"Template item."},"maxItems":100}},"required":["title","items"],"description":"Sub-section of a template (one level, ADR-0048)."},"maxItems":50},"repeat":{"type":"object","nullable":true,"properties":{"min":{"type":"integer","minimum":0,"maximum":10,"description":"Fewest repeats the client must add (0 = the group may be skipped)."},"max":{"type":"integer","minimum":1,"maximum":20,"description":"Most repeats the client may add."}},"required":["min","max"],"additionalProperties":false,"description":"Repeatable group (PRF-03): when present the section repeats min..max times (one block per repeat); absent or null is exactly one."}},"required":["title","items"],"description":"Section of a template, with optional sub-sections."},"minItems":1,"maxItems":50}},"required":["name","description","profession","coverInstructions","sections"],"additionalProperties":false,"description":"Save a firm template (organisation content, no client data). At least one item."}}}},"responses":{"200":{"description":"The updated template.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","maxLength":100},"name":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"description":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"profession":{"type":"string","enum":["legal","mortgage","notary","accounting","insolvency","general"],"description":"Profession a request template is made for."},"builtIn":{"type":"boolean","description":"False for a template the firm saved (editable)."},"coverInstructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Cover \"Instructies\" page of requests made from this template."},"participants":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Expected answer slot of this participant."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the participant (firm dossier vocabulary)."}},"required":["slot","label"],"description":"Expected participant of a firm template: answer slot plus display label."},"maxItems":10,"description":"Expected named slots of this template (roles only); absent on unrostered templates."},"updatedAt":{"type":"string","format":"date-time"},"contentHash":{"type":"string","pattern":"^[a-f0-9]{64}$","description":"Exact content fingerprint of a saved firm template (SP07). Required to pin a firm template reference in a versioned dossier pack; absent for read-only built-in starters, whose version is 1."},"sections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"items":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Instruction text in the safe rich-text subset (ADR-0048)."},"footnote":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"Defaults to `file`."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false},"maxItems":30}},"additionalProperties":false,"description":"Template answer rules (ADR-0048)."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named item icon of the request form (ADR-0048); the web maps it onto the icon set."},"required":{"type":"boolean"},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for; null or absent is shared."},"allowNotApplicable":{"type":"boolean","description":"Defaults to the inverse of `required`."},"allowMultiple":{"type":"boolean","description":"Defaults to true."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50},"targetPath":{"type":"string","nullable":true,"maxLength":200,"description":"Title of a top-level room folder."},"bsnAutoMask":{"type":"boolean","description":"Default of the item: burn every BSN out of a delivered file (ADR-0053)."},"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650,"description":"Default validity rule of the item in days (ADR-0053)."}},"required":["title","instructions","required","targetPath"],"description":"Template item."},"maxItems":100},"subsections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"items":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Instruction text in the safe rich-text subset (ADR-0048)."},"footnote":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"Defaults to `file`."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false},"maxItems":30}},"additionalProperties":false,"description":"Template answer rules (ADR-0048)."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named item icon of the request form (ADR-0048); the web maps it onto the icon set."},"required":{"type":"boolean"},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for; null or absent is shared."},"allowNotApplicable":{"type":"boolean","description":"Defaults to the inverse of `required`."},"allowMultiple":{"type":"boolean","description":"Defaults to true."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50},"targetPath":{"type":"string","nullable":true,"maxLength":200,"description":"Title of a top-level room folder."},"bsnAutoMask":{"type":"boolean","description":"Default of the item: burn every BSN out of a delivered file (ADR-0053)."},"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650,"description":"Default validity rule of the item in days (ADR-0053)."}},"required":["title","instructions","required","targetPath"],"description":"Template item."},"maxItems":100}},"required":["title","items"],"description":"Sub-section of a template (one level, ADR-0048)."},"maxItems":50},"repeat":{"type":"object","nullable":true,"properties":{"min":{"type":"integer","minimum":0,"maximum":10,"description":"Fewest repeats the client must add (0 = the group may be skipped)."},"max":{"type":"integer","minimum":1,"maximum":20,"description":"Most repeats the client may add."}},"required":["min","max"],"additionalProperties":false,"description":"Repeatable group (PRF-03): when present the section repeats min..max times (one block per repeat); absent or null is exactly one."}},"required":["title","items"],"description":"Section of a template, with optional sub-sections."}}},"required":["id","name","description","sections"],"description":"Request template (request-flow profile)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (not a firm admin).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or template, or a built-in template.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"delete":{"operationId":"archiveRequestTemplate","summary":"Archive a firm request template","description":"Marks a firm template archived (it leaves the library; requests made from it keep their content). No row is deleted. Requires flow_template.manage. Writes flow_template.archived.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","maxLength":100},"required":true,"name":"templateId","in":"path"}],"responses":{"204":{"description":"Archived."},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (not a firm admin).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or template, or a built-in template.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/portal/requests/{token}/items/{itemId}/submit":{"post":{"operationId":"submitPortalItem","summary":"Submit one item for review (locks it)","description":"Sends the draft files or the draft not-applicable claim of one item to the firm: the item becomes submitted and is locked for the client until the firm rejects it (ADR-0048 \"Indienen ter beoordeling\"). Requires flow_item.submit (files) or flow_item.respond (claim) on the item, single strength (ADR-0013 D1). Writes flow_item.submitted with the session strength. 409 NOTHING_TO_SUBMIT when the item has nothing prepared.","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Link token from the request e-mail. Never a credential on its own."},"required":true,"description":"Link token from the request e-mail. Never a credential on its own.","name":"token","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"}],"responses":{"200":{"description":"Updated request.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipientName":{"type":"string"},"applicantSlot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"The applicant slot this guest link is bound to (M2/HYP-03). Absent on a legacy single-recipient link, where the guest may fill every slot; present on a shared request, where the view carries only this slot’s private files and answers."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."}},"required":["slot","label"],"additionalProperties":false},"description":"Named room parties of this request (WF01): slot and display label only, so a party learns no internal group id. Empty on legacy rows."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): this portal shares every bound slot’s drafts. False keeps the slot-private view."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance (ids and period keys only). Null on legacy rows without a period."},"firm":{"type":"object","properties":{"name":{"type":"string"},"initials":{"type":"string","maxLength":4},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Vertical of the firm that owns the request (ADR-0030); drives the mortgage upload notices."},"logoUrl":{"type":"string","maxLength":300,"description":"Same-origin URL of the firm logo (public branding asset), when the firm set one."}},"required":["name","initials"]},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"claimReceipt":{"type":"object","properties":{"status":{"type":"string","enum":["not_submitted","received","correction_requested","under_review"],"description":"Guest-safe creditor claim status (WF04); never an internal acceptance or ranking."},"reference":{"type":"string","nullable":true,"maxLength":100,"description":"The creditor's own claim reference, echoed back; null until it is filed."},"itemCount":{"type":"integer","minimum":0,"description":"Items of the claim request."},"submittedCount":{"type":"integer","minimum":0,"description":"Items delivered so far."},"correctionCount":{"type":"integer","minimum":0,"description":"Items the firm sent back for correction."},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"First/last submit time of the claim; null when none."}},"required":["status","reference","itemCount","submittedCount","correctionCount","submittedAt"],"additionalProperties":false,"description":"Own receipt and guest-safe status of a creditor claim (WF04); present on insolvency creditor requests, absent elsewhere. Never carries another creditor data."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number"],"description":"Request item as the client sees it."}}},"required":["title","message","status","dueDate","recipientName","parties","joint","periodContext","firm","submittedAt","expiresAt","coverInstructions","displayStatus","progress","sections","items"],"description":"Document request in the client portal."}}}},"401":{"description":"Sign in with the e-mail code first.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown link or item.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"NOTHING_TO_SUBMIT or ITEM_NOT_OPEN.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/client-workspace/{token}/requests/{flowId}/items/{itemId}/submit":{"post":{"operationId":"submitClientWorkspaceItem","summary":"Submit one item for review from the client workspace (locks it)","description":"Same as submitPortalItem, addressed by the client-workspace invitation token plus the request id (ADR-0047): the item becomes submitted and stays locked for the client until the firm rejects it. Requires flow_item.submit (files) or flow_item.respond (claim) on the item. Writes flow_item.submitted with the session strength.","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Link token from the request e-mail. Never a credential on its own."},"required":true,"description":"Link token from the request e-mail. Never a credential on its own.","name":"token","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"}],"responses":{"200":{"description":"Updated request.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipientName":{"type":"string"},"applicantSlot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"The applicant slot this guest link is bound to (M2/HYP-03). Absent on a legacy single-recipient link, where the guest may fill every slot; present on a shared request, where the view carries only this slot’s private files and answers."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."}},"required":["slot","label"],"additionalProperties":false},"description":"Named room parties of this request (WF01): slot and display label only, so a party learns no internal group id. Empty on legacy rows."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): this portal shares every bound slot’s drafts. False keeps the slot-private view."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance (ids and period keys only). Null on legacy rows without a period."},"firm":{"type":"object","properties":{"name":{"type":"string"},"initials":{"type":"string","maxLength":4},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Vertical of the firm that owns the request (ADR-0030); drives the mortgage upload notices."},"logoUrl":{"type":"string","maxLength":300,"description":"Same-origin URL of the firm logo (public branding asset), when the firm set one."}},"required":["name","initials"]},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"claimReceipt":{"type":"object","properties":{"status":{"type":"string","enum":["not_submitted","received","correction_requested","under_review"],"description":"Guest-safe creditor claim status (WF04); never an internal acceptance or ranking."},"reference":{"type":"string","nullable":true,"maxLength":100,"description":"The creditor's own claim reference, echoed back; null until it is filed."},"itemCount":{"type":"integer","minimum":0,"description":"Items of the claim request."},"submittedCount":{"type":"integer","minimum":0,"description":"Items delivered so far."},"correctionCount":{"type":"integer","minimum":0,"description":"Items the firm sent back for correction."},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"First/last submit time of the claim; null when none."}},"required":["status","reference","itemCount","submittedCount","correctionCount","submittedAt"],"additionalProperties":false,"description":"Own receipt and guest-safe status of a creditor claim (WF04); present on insolvency creditor requests, absent elsewhere. Never carries another creditor data."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number"],"description":"Request item as the client sees it."}},"id":{"type":"string","format":"uuid","description":"Request id (addresses the item actions of the workspace)."},"sentAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["title","message","status","dueDate","recipientName","parties","joint","periodContext","firm","submittedAt","expiresAt","coverInstructions","displayStatus","progress","sections","items","id","sentAt"],"description":"A document request in the client workspace."}}}},"401":{"description":"Sign in with the e-mail code first.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown link, request or item.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"NOTHING_TO_SUBMIT or ITEM_NOT_OPEN.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/portal/requests/{token}/items/{itemId}/files/{fileId}/download":{"get":{"operationId":"downloadPortalFile","summary":"Download an own delivered file","description":"The original bytes of a file this guest uploaded into the item (draft, submitted or approved; never another person’s file). The server decrypts under the room key in the guest intake path (ADR-0025 D3); the key never reaches the guest. Requires flow_item.read on the item. Writes document.downloaded (variant original) as the guest.","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Link token from the request e-mail. Never a credential on its own."},"required":true,"description":"Link token from the request e-mail. Never a credential on its own.","name":"token","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"fileId","in":"path"}],"responses":{"200":{"description":"The file (Content-Disposition attachment; the name is the uploaded name).","content":{"application/octet-stream":{"schema":{"type":"string","description":"The file bytes."}}}},"401":{"description":"Sign in with the e-mail code first.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown link, item or file, or not this guest’s file.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/portal/requests/{token}/items/{itemId}/answer":{"put":{"operationId":"savePortalAnswer","summary":"Save the draft answer of an item","description":"Saves the draft answer of an answer item (short or long text, number, amount, date, yes/no, choice), validated against the item rules on the server; null clears it. The answer is client data: it is stored like other request text and never logged or audited (the submit writes flow_item.submitted with kind answer, ids only). Requires flow_item.respond on an open item (single strength). \"Submit for review\" sends and locks it.","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Link token from the request e-mail. Never a credential on its own."},"required":true,"description":"Link token from the request e-mail. Never a credential on its own.","name":"token","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30},{"nullable":true}],"description":"Answer value (client data; never logged or audited)."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot answering; defaults to `applicant_1` (unknown slots are 400)."},"expectedRevision":{"type":"integer","minimum":0,"description":"Item view revision the saver saw; when present, a newer stored revision refuses with 409 ANSWER_CONFLICT instead of overwriting (cross-tab lost-update guard). Omitted keeps the legacy overwrite."}},"required":["value"],"additionalProperties":false,"description":"Save the draft answer of an item (validated against its rules on the server)."}}}},"responses":{"200":{"description":"Updated request.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipientName":{"type":"string"},"applicantSlot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"The applicant slot this guest link is bound to (M2/HYP-03). Absent on a legacy single-recipient link, where the guest may fill every slot; present on a shared request, where the view carries only this slot’s private files and answers."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."}},"required":["slot","label"],"additionalProperties":false},"description":"Named room parties of this request (WF01): slot and display label only, so a party learns no internal group id. Empty on legacy rows."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): this portal shares every bound slot’s drafts. False keeps the slot-private view."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance (ids and period keys only). Null on legacy rows without a period."},"firm":{"type":"object","properties":{"name":{"type":"string"},"initials":{"type":"string","maxLength":4},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Vertical of the firm that owns the request (ADR-0030); drives the mortgage upload notices."},"logoUrl":{"type":"string","maxLength":300,"description":"Same-origin URL of the firm logo (public branding asset), when the firm set one."}},"required":["name","initials"]},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"claimReceipt":{"type":"object","properties":{"status":{"type":"string","enum":["not_submitted","received","correction_requested","under_review"],"description":"Guest-safe creditor claim status (WF04); never an internal acceptance or ranking."},"reference":{"type":"string","nullable":true,"maxLength":100,"description":"The creditor's own claim reference, echoed back; null until it is filed."},"itemCount":{"type":"integer","minimum":0,"description":"Items of the claim request."},"submittedCount":{"type":"integer","minimum":0,"description":"Items delivered so far."},"correctionCount":{"type":"integer","minimum":0,"description":"Items the firm sent back for correction."},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"First/last submit time of the claim; null when none."}},"required":["status","reference","itemCount","submittedCount","correctionCount","submittedAt"],"additionalProperties":false,"description":"Own receipt and guest-safe status of a creditor claim (WF04); present on insolvency creditor requests, absent elsewhere. Never carries another creditor data."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number"],"description":"Request item as the client sees it."}}},"required":["title","message","status","dueDate","recipientName","parties","joint","periodContext","firm","submittedAt","expiresAt","coverInstructions","displayStatus","progress","sections","items"],"description":"Document request in the client portal."}}}},"400":{"description":"A specific ANSWER_* issue code or not an answer item.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Sign in with the e-mail code first.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown link or item.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"ITEM_NOT_OPEN, or ANSWER_CONFLICT when the body carried expectedRevision and another tab saved a newer draft first (resend with the current item revision).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/client-workspace/{token}/requests/{flowId}/items/{itemId}/answer":{"put":{"operationId":"saveClientWorkspaceAnswer","summary":"Save the draft answer of an item from the client workspace","description":"Same as savePortalAnswer, addressed by the client-workspace token plus the request id (ADR-0047). Saves the draft answer of an answer item (short or long text, number, amount, date, yes/no, choice), validated against the item rules on the server; null clears it. The answer is client data: it is stored like other request text and never logged or audited (the submit writes flow_item.submitted with kind answer, ids only). Requires flow_item.respond on an open item (single strength). \"Submit for review\" sends and locks it.","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$","description":"Link token from the request e-mail. Never a credential on its own."},"required":true,"description":"Link token from the request e-mail. Never a credential on its own.","name":"token","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30},{"nullable":true}],"description":"Answer value (client data; never logged or audited)."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot answering; defaults to `applicant_1` (unknown slots are 400)."},"expectedRevision":{"type":"integer","minimum":0,"description":"Item view revision the saver saw; when present, a newer stored revision refuses with 409 ANSWER_CONFLICT instead of overwriting (cross-tab lost-update guard). Omitted keeps the legacy overwrite."}},"required":["value"],"additionalProperties":false,"description":"Save the draft answer of an item (validated against its rules on the server)."}}}},"responses":{"200":{"description":"Updated request.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipientName":{"type":"string"},"applicantSlot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"The applicant slot this guest link is bound to (M2/HYP-03). Absent on a legacy single-recipient link, where the guest may fill every slot; present on a shared request, where the view carries only this slot’s private files and answers."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."}},"required":["slot","label"],"additionalProperties":false},"description":"Named room parties of this request (WF01): slot and display label only, so a party learns no internal group id. Empty on legacy rows."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): this portal shares every bound slot’s drafts. False keeps the slot-private view."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance (ids and period keys only). Null on legacy rows without a period."},"firm":{"type":"object","properties":{"name":{"type":"string"},"initials":{"type":"string","maxLength":4},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Vertical of the firm that owns the request (ADR-0030); drives the mortgage upload notices."},"logoUrl":{"type":"string","maxLength":300,"description":"Same-origin URL of the firm logo (public branding asset), when the firm set one."}},"required":["name","initials"]},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"claimReceipt":{"type":"object","properties":{"status":{"type":"string","enum":["not_submitted","received","correction_requested","under_review"],"description":"Guest-safe creditor claim status (WF04); never an internal acceptance or ranking."},"reference":{"type":"string","nullable":true,"maxLength":100,"description":"The creditor's own claim reference, echoed back; null until it is filed."},"itemCount":{"type":"integer","minimum":0,"description":"Items of the claim request."},"submittedCount":{"type":"integer","minimum":0,"description":"Items delivered so far."},"correctionCount":{"type":"integer","minimum":0,"description":"Items the firm sent back for correction."},"submittedAt":{"type":"string","nullable":true,"format":"date-time","description":"First/last submit time of the claim; null when none."}},"required":["status","reference","itemCount","submittedCount","correctionCount","submittedAt"],"additionalProperties":false,"description":"Own receipt and guest-safe status of a creditor claim (WF04); present on insolvency creditor requests, absent elsewhere. Never carries another creditor data."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number"],"description":"Request item as the client sees it."}},"id":{"type":"string","format":"uuid","description":"Request id (addresses the item actions of the workspace)."},"sentAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["title","message","status","dueDate","recipientName","parties","joint","periodContext","firm","submittedAt","expiresAt","coverInstructions","displayStatus","progress","sections","items","id","sentAt"],"description":"A document request in the client workspace."}}}},"400":{"description":"A specific ANSWER_* issue code or not an answer item.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Sign in with the e-mail code first.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown link, request or item.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"ITEM_NOT_OPEN, or ANSWER_CONFLICT when the body carried expectedRevision and another tab saved a newer draft first (resend with the current item revision).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/retention/profession-profile":{"get":{"operationId":"getProfessionProfile","summary":"Read the firm profession profile and the profile catalogue","description":"The chosen (or vertical-derived) profession profile with every profile of the platform: default room types, the profession label per room type, dossier labels and the default retention classes per room type (PRF-05/06, ADR-0058). retention.overview.read (firm_admin or compliance). No audit event.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"Profile state.","content":{"application/json":{"schema":{"type":"object","properties":{"current":{"type":"string","enum":["legal","mortgage","notary","accountancy","financial_planning","mediation","insolvency","real_estate","mergers_acquisitions","fundraising","public_sector","corporate","healthcare_life_sciences"],"description":"Profession profile of the firm (ADR-0058): seven legacy profiles plus six additive sector profiles. A profile only groups packs and wording; it never grants access."},"explicit":{"type":"boolean","description":"True when the firm picked the profile; false when it follows from the vertical."},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Firm vertical: legal (law firm) or mortgage (mortgage adviser)."},"profiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","enum":["legal","mortgage","notary","accountancy","financial_planning","mediation","insolvency","real_estate","mergers_acquisitions","fundraising","public_sector","corporate","healthcare_life_sciences"],"description":"Profession profile of the firm (ADR-0058): seven legacy profiles plus six additive sector profiles. A profile only groups packs and wording; it never grants access."},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Firm vertical: legal (law firm) or mortgage (mortgage adviser)."},"wwft":{"type":"boolean","description":"The profession falls under the Wwft (CDD records, class wwft_cdd)."},"roomTypes":{"type":"array","items":{"type":"object","properties":{"roomType":{"type":"string","enum":["client_portal","litigation","mortgage_advice"],"description":"Room type the firm allows."},"label":{"type":"string","enum":["client_file","litigation_file","wwft_file","advice_file","aftercare_file","deed_file","environmental_file","transfer_file","annual_accounts_file","tax_return_file","pbc_list","financial_plan","mifid_file","mediation_file","settlement_agreement","estate_file","bankruptcy_report","sale_dataroom"],"description":"Dossier label code of a profession profile (ADR-0058)."},"classIds":{"type":"array","items":{"type":"string","enum":["legal_file","legal_financial_record","legal_liability_long","wwft_cdd","mortgage_advice_file","mortgage_supporting","mortgage_identity_copy","general_room","notary_file","notary_environmental","accountancy_record","financial_advice_file","mifid_record","mediation_file","insolvency_estate"],"description":"Platform retention class id (ADR-0012 D2); tenants cannot create classes in the MVP."},"minItems":1}},"required":["roomType","label","classIds"]},"description":"Default room types with the profession label and default retention classes."},"dossierLabels":{"type":"array","items":{"type":"string","enum":["client_file","litigation_file","wwft_file","advice_file","aftercare_file","deed_file","environmental_file","transfer_file","annual_accounts_file","tax_return_file","pbc_list","financial_plan","mifid_file","mediation_file","settlement_agreement","estate_file","bankruptcy_report","sale_dataroom"],"description":"Dossier label code of a profession profile (ADR-0058)."}},"starterRequestProfessions":{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"description":"Starter request-template professions this profile offers first for a new dossier (PRF-05). Existing dossiers never change."},"starterIndexRoomTypes":{"type":"array","items":{"type":"string","enum":["client_portal","litigation","mortgage_advice"],"description":"Room type the firm allows."},"description":"Starter index room types this profile offers for a new dossier (PRF-05). Existing dossiers keep their own index."}},"required":["id","vertical","wwft","roomTypes","dossierLabels","starterRequestProfessions","starterIndexRoomTypes"],"description":"One profession profile (platform data, ADR-0058)."}}},"required":["current","explicit","vertical","profiles"],"description":"The firm profession profile and the profile catalogue (PRF-05/06)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Not a firm admin or compliance officer; guests and support.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"put":{"operationId":"setProfessionProfile","summary":"Pick the firm profession profile","description":"Stores the profile, sets the profile's vertical (ADR-0030) and adds its room types to the allowed room types. Firm schedule rows (room_type_retention) and class durations stay; the profile only changes the defaults, so no computed room date gets shorter. retention.settings.update (firm_admin, step-up). Writes retention.profile_applied.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"profile":{"type":"string","enum":["legal","mortgage","notary","accountancy","financial_planning","mediation","insolvency","real_estate","mergers_acquisitions","fundraising","public_sector","corporate","healthcare_life_sciences"],"description":"Profession profile of the firm (ADR-0058): seven legacy profiles plus six additive sector profiles. A profile only groups packs and wording; it never grants access."}},"required":["profile"],"additionalProperties":false,"description":"Pick the firm profession profile. Sets the vertical of the profile and adds its room types; firm schedule rows stay."}}}},"responses":{"200":{"description":"Profile state after the change.","content":{"application/json":{"schema":{"type":"object","properties":{"current":{"type":"string","enum":["legal","mortgage","notary","accountancy","financial_planning","mediation","insolvency","real_estate","mergers_acquisitions","fundraising","public_sector","corporate","healthcare_life_sciences"],"description":"Profession profile of the firm (ADR-0058): seven legacy profiles plus six additive sector profiles. A profile only groups packs and wording; it never grants access."},"explicit":{"type":"boolean","description":"True when the firm picked the profile; false when it follows from the vertical."},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Firm vertical: legal (law firm) or mortgage (mortgage adviser)."},"profiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","enum":["legal","mortgage","notary","accountancy","financial_planning","mediation","insolvency","real_estate","mergers_acquisitions","fundraising","public_sector","corporate","healthcare_life_sciences"],"description":"Profession profile of the firm (ADR-0058): seven legacy profiles plus six additive sector profiles. A profile only groups packs and wording; it never grants access."},"vertical":{"type":"string","enum":["legal","mortgage"],"description":"Firm vertical: legal (law firm) or mortgage (mortgage adviser)."},"wwft":{"type":"boolean","description":"The profession falls under the Wwft (CDD records, class wwft_cdd)."},"roomTypes":{"type":"array","items":{"type":"object","properties":{"roomType":{"type":"string","enum":["client_portal","litigation","mortgage_advice"],"description":"Room type the firm allows."},"label":{"type":"string","enum":["client_file","litigation_file","wwft_file","advice_file","aftercare_file","deed_file","environmental_file","transfer_file","annual_accounts_file","tax_return_file","pbc_list","financial_plan","mifid_file","mediation_file","settlement_agreement","estate_file","bankruptcy_report","sale_dataroom"],"description":"Dossier label code of a profession profile (ADR-0058)."},"classIds":{"type":"array","items":{"type":"string","enum":["legal_file","legal_financial_record","legal_liability_long","wwft_cdd","mortgage_advice_file","mortgage_supporting","mortgage_identity_copy","general_room","notary_file","notary_environmental","accountancy_record","financial_advice_file","mifid_record","mediation_file","insolvency_estate"],"description":"Platform retention class id (ADR-0012 D2); tenants cannot create classes in the MVP."},"minItems":1}},"required":["roomType","label","classIds"]},"description":"Default room types with the profession label and default retention classes."},"dossierLabels":{"type":"array","items":{"type":"string","enum":["client_file","litigation_file","wwft_file","advice_file","aftercare_file","deed_file","environmental_file","transfer_file","annual_accounts_file","tax_return_file","pbc_list","financial_plan","mifid_file","mediation_file","settlement_agreement","estate_file","bankruptcy_report","sale_dataroom"],"description":"Dossier label code of a profession profile (ADR-0058)."}},"starterRequestProfessions":{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"description":"Starter request-template professions this profile offers first for a new dossier (PRF-05). Existing dossiers never change."},"starterIndexRoomTypes":{"type":"array","items":{"type":"string","enum":["client_portal","litigation","mortgage_advice"],"description":"Room type the firm allows."},"description":"Starter index room types this profile offers for a new dossier (PRF-05). Existing dossiers keep their own index."}},"required":["id","vertical","wwft","roomTypes","dossierLabels","starterRequestProfessions","starterIndexRoomTypes"],"description":"One profession profile (platform data, ADR-0058)."}}},"required":["current","explicit","vertical","profiles"],"description":"The firm profession profile and the profile catalogue (PRF-05/06)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out, or STEP_UP_REQUIRED.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Not a firm admin; guests and support.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/flow-schedules":{"get":{"operationId":"listFlowSchedules","summary":"List the recurring request schedules of a room","description":"Schedules with their interval, status and next date (PRF-04, ADR-0058). flow.read on the room (firm users only; refusals are 404). No audit event.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"Schedules.","content":{"application/json":{"schema":{"type":"object","properties":{"schedules":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"sourceFlowId":{"type":"string","format":"uuid","description":"The request the schedule was made from."},"lastFlowId":{"type":"string","format":"uuid","description":"The latest request of the schedule; the next copy is made from it."},"interval":{"type":"string","enum":["monthly","quarterly","yearly"],"description":"How often the request repeats: every month, every quarter or every year."},"status":{"type":"string","enum":["active","paused","stopped"],"description":"active runs at nextRunOn; paused skips runs until resumed; stopped is final."},"nextRunOn":{"type":"string","nullable":true,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date of the next copy; null once stopped."},"runCount":{"type":"integer","minimum":0},"lastRunAt":{"type":"string","nullable":true,"format":"date-time"},"failureCode":{"type":"string","nullable":true,"pattern":"^[A-Z][A-Z0-9_]{0,62}$","description":"Why the last run did not send (the schedule is then paused)."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","roomId","sourceFlowId","lastFlowId","interval","status","nextRunOn","runCount","lastRunAt","failureCode","createdAt","updatedAt"],"description":"Recurring request schedule (PRF-04)."}}},"required":["schedules"],"description":"Recurring request schedules of a room (not stopped first)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown room, not visible, guest or cross-tenant.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/flows/{flowId}/schedule":{"post":{"operationId":"createFlowSchedule","summary":"Repeat a sent request monthly, quarterly or yearly","description":"Creates a schedule for a request that was sent (not a draft). The worker copies the latest request of the schedule at each date (same items, no answers or files, due date one interval on), sends it through the normal send path and notifies the firm. One live schedule per request. flow.create on the room (manage). Writes flow_schedule.created.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"interval":{"type":"string","enum":["monthly","quarterly","yearly"],"description":"How often the request repeats: every month, every quarter or every year."}},"required":["interval"],"additionalProperties":false,"description":"Repeat a sent request every month, quarter or year."}}}},"responses":{"201":{"description":"Schedule.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"sourceFlowId":{"type":"string","format":"uuid","description":"The request the schedule was made from."},"lastFlowId":{"type":"string","format":"uuid","description":"The latest request of the schedule; the next copy is made from it."},"interval":{"type":"string","enum":["monthly","quarterly","yearly"],"description":"How often the request repeats: every month, every quarter or every year."},"status":{"type":"string","enum":["active","paused","stopped"],"description":"active runs at nextRunOn; paused skips runs until resumed; stopped is final."},"nextRunOn":{"type":"string","nullable":true,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date of the next copy; null once stopped."},"runCount":{"type":"integer","minimum":0},"lastRunAt":{"type":"string","nullable":true,"format":"date-time"},"failureCode":{"type":"string","nullable":true,"pattern":"^[A-Z][A-Z0-9_]{0,62}$","description":"Why the last run did not send (the schedule is then paused)."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","roomId","sourceFlowId","lastFlowId","interval","status","nextRunOn","runCount","lastRunAt","failureCode","createdAt","updatedAt"],"description":"Recurring request schedule (PRF-04)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"No manage right on the room, or the room is not active.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown room or request (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"CONFLICT: the request is still a draft, or it already has a live schedule.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/flow-schedules/{scheduleId}":{"patch":{"operationId":"updateFlowSchedule","summary":"Pause, resume or stop a recurring request","description":"active resumes (the next date moves to the first future date of the interval), paused skips runs, stopped is final. flow.create on the room. Writes flow_schedule.changed.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"scheduleId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["active","paused","stopped"],"description":"active runs at nextRunOn; paused skips runs until resumed; stopped is final."}},"required":["status"],"additionalProperties":false,"description":"Pause, resume or stop a schedule. A stopped schedule cannot be resumed."}}}},"responses":{"200":{"description":"Schedule.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"sourceFlowId":{"type":"string","format":"uuid","description":"The request the schedule was made from."},"lastFlowId":{"type":"string","format":"uuid","description":"The latest request of the schedule; the next copy is made from it."},"interval":{"type":"string","enum":["monthly","quarterly","yearly"],"description":"How often the request repeats: every month, every quarter or every year."},"status":{"type":"string","enum":["active","paused","stopped"],"description":"active runs at nextRunOn; paused skips runs until resumed; stopped is final."},"nextRunOn":{"type":"string","nullable":true,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date of the next copy; null once stopped."},"runCount":{"type":"integer","minimum":0},"lastRunAt":{"type":"string","nullable":true,"format":"date-time"},"failureCode":{"type":"string","nullable":true,"pattern":"^[A-Z][A-Z0-9_]{0,62}$","description":"Why the last run did not send (the schedule is then paused)."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","roomId","sourceFlowId","lastFlowId","interval","status","nextRunOn","runCount","lastRunAt","failureCode","createdAt","updatedAt"],"description":"Recurring request schedule (PRF-04)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"No manage right on the room.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown schedule (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"CONFLICT: the schedule is stopped.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/flows/{flowId}/copy":{"post":{"operationId":"copyFlow","summary":"Copy a request into a new draft (\"Kopieer van vorig jaar\")","description":"A new draft in the same room with the same recipient, sections and items; no answers, files or decisions. The due date moves one year on unless given. flow.create on the room (manage). Writes flow.created and flow.copied.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"dueDate":{"type":"string","nullable":true,"format":"date-time","description":"Due date of the copy; absent = the source due date moved one year on (or none)."},"periodKey":{"type":"string","pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period the copy collects evidence for (WF06, e.g. the next boekjaar). Absent = the copy keeps no new period. Copy provenance (source request and period) is server-authoritative and never taken from this body."},"includeAnswers":{"type":"boolean","description":"Copy the eligible answers of the source request as editable drafts (default false = the legacy empty copy). Submitted/review state is reset; files, decisions, tokens and share links never come along."}},"additionalProperties":false,"description":"Copy a request into a new draft: same sections and items; with `includeAnswers` the same-bound draft answers are prefilled."}}}},"responses":{"201":{"description":"The draft.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"templateId":{"type":"string","nullable":true,"maxLength":100},"title":{"type":"string"},"message":{"type":"string","nullable":true},"status":{"type":"string","enum":["draft","sent","completed","closed"],"description":"Flow state (INT-F03, INT-F18)."},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"recipient":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"email":{"type":"string","maxLength":320,"format":"email"}},"required":["name","email"],"description":"The one person a request is addressed to (client data)."},"portalUrl":{"type":"string","nullable":true,"description":"Always null on the real stack: the link token is only ever in the request e-mail."},"parties":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group bound to the party; null until the firm binds it."}},"required":["slot","label","groupId"],"additionalProperties":false,"description":"Room-bound party of a request (WF01): applicant slot, display label, room group."},"description":"Named room parties of this request (WF01); empty on legacy rows without a scope."},"joint":{"type":"boolean","description":"Explicitly joint request (WF01): bound parties share drafts. False keeps slot-private answers."},"periodContext":{"type":"object","nullable":true,"properties":{"periodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period this request collects evidence for; null when the firm set none."},"sourceFlowId":{"type":"string","nullable":true,"format":"uuid","description":"Request prefilled drafts were copied from; null on a manually started period."},"sourcePeriodKey":{"type":"string","nullable":true,"pattern":"^\\d{4}$|^\\d{4}-Q[1-4]$|^\\d{4}-(0[1-9]|1[0-2])$","description":"Engagement period prefilled drafts came from; null when the source had none."}},"required":["periodKey","sourceFlowId","sourcePeriodKey"],"additionalProperties":false,"description":"Period context of the request (WF06): engagement period plus copy provenance. Null on legacy rows without a period."},"expiresAt":{"type":"string","nullable":true,"format":"date-time","description":"Expiry date of the form (\"Vervaldatum\", ADR-0048)."},"coverInstructions":{"type":"string","nullable":true,"description":"The cover \"Instructies\" page (safe rich-text subset, ADR-0048)."},"displayStatus":{"type":"string","enum":["concept","active","expired","completed","closed"],"description":"Derived form status: concept (draft), active (sent), expired (sent, past the expiry date), completed, closed."},"progress":{"type":"object","properties":{"client":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"firm":{"type":"object","properties":{"done":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0}},"required":["done","total"]},"toReview":{"type":"integer","minimum":0}},"required":["client","firm","toReview"],"description":"Progress counters (INT-F18): the client counts delivered items, the firm decided ones."},"sections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"parentId":{"type":"string","nullable":true,"format":"uuid","description":"Parent section for a sub-section (one level, ADR-0048)."},"number":{"type":"string","maxLength":20,"description":"Outline number, e.g. \"2\" or \"2.1\"."}},"required":["id","position","title","instructions","parentId","number"],"description":"Section of a request."}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"sectionId":{"type":"string","format":"uuid"},"position":{"type":"integer","minimum":0},"title":{"type":"string"},"instructions":{"type":"string","nullable":true},"required":{"type":"boolean"},"allowNotApplicable":{"type":"boolean"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["to_do","submitted","approved","rejected","not_applicable"],"description":"Item status (INT-F14, request-flow profile)."},"revision":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of this item (WF05): slot-private, or joint when the mediator explicitly shared it with every bound party."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Item file id."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","default":"applicant_1","description":"Applicant slot that filed this document (M2 repeatable applicants): one file group per slot; legacy files read as `applicant_1`."},"name":{"type":"string","maxLength":500},"size":{"type":"integer","minimum":0},"uploadedAt":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["draft","submitted","approved","rejected"],"description":"State of one delivered file: a draft until the client sends it, then decided by the firm."},"documentId":{"type":"string","format":"uuid","description":"The stored document (firm view only)."},"bsnMask":{"type":"object","nullable":true,"properties":{"state":{"type":"string","enum":["pending","requested","none","masked","unsupported","failed"],"description":"BSN masking state of a delivered file (ADR-0053)."},"hitCount":{"type":"integer","nullable":true,"minimum":0,"description":"Numbers burned out; null until settled."},"maskedVersionId":{"type":"string","nullable":true,"format":"uuid","description":"The redacted version (the current one)."},"maskedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["state","hitCount","maskedVersionId","maskedAt"],"description":"BSN masking of the file (firm view only; null when never asked for)."}},"required":["id","name","size","uploadedAt","state"],"description":"File of a request item."}},"notApplicable":{"type":"object","nullable":true,"properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["reasonCode","note","submitted"],"description":"The client’s not-applicable claim for an item."},"slotNotApplicable":{"type":"array","items":{"type":"object","properties":{"reasonCode":{"type":"string","enum":["does_not_apply","not_available","other"],"description":"Not-applicable reason code (INT-F12); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"submitted":{"type":"boolean","description":"False while it is the client’s draft."},"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$"}},"required":["reasonCode","note","submitted","slot"]}},"decision":{"type":"object","nullable":true,"properties":{"action":{"type":"string","enum":["approve","reject"]},"reasonCode":{"type":"string","nullable":true,"enum":["illegible","incomplete","wrong_document","too_old","wrong_person","other",null],"description":"Reject reason code (INT-F16); `other` requires a note."},"note":{"type":"string","nullable":true,"maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["action","reasonCode","note"],"description":"Latest review decision on an item."},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"author":{"type":"string","enum":["professional","client"]},"body":{"type":"string","maxLength":4000},"at":{"type":"string","format":"date-time"}},"required":["id","author","body","at"],"description":"One message of the per-item question thread."}},"validity":{"type":"object","nullable":true,"properties":{"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650},"validUntil":{"type":"string","nullable":true,"format":"date"},"daysLeft":{"type":"integer","nullable":true},"status":{"type":"string","enum":["valid","expiring","expired","unknown"]},"source":{"type":"string","enum":["document_date","upload_date","none"],"description":"What the end date was counted from."}},"required":["validForDays","validUntil","daysLeft","status","source"],"description":"Validity of the delivered document (ADR-0053); null without a rule."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for (M2 F05); null or absent is shared with every participant. A label only, never an access grant."},"visible":{"type":"boolean","description":"False when a condition hides the item (it then does not count)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"What the item asks for: files or an answer of a kind (ADR-0048)."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["code","label"],"additionalProperties":false},"maxItems":30,"description":"Choice: the options."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."}},"additionalProperties":false,"description":"Answer rules (ADR-0048)."},"answer":{"type":"object","nullable":true,"properties":{"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the client’s draft."}},"required":["value","submitted"],"description":"The client’s answer (answer items only)."},"slotAnswers":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"value":{"anyOf":[{"type":"string","maxLength":10000},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string","maxLength":40},"maxItems":30}],"description":"Answer value (client data; never logged or audited)."},"submitted":{"type":"boolean","description":"False while it is the applicant’s draft."}},"required":["slot","value","submitted"],"description":"One applicant slot’s answer to an item (M2 repeatable applicants)."},"description":"Per-applicant answers by slot (M2 repeatable applicants): one entry per slot that answered; legacy rows read as a single `applicant_1` entry."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named icon shown on the item card and in the outline."},"footnote":{"type":"string","nullable":true,"maxLength":2000,"description":"Italic footnote under the instructions (safe rich-text subset)."},"allowMultiple":{"type":"boolean","description":"Whether the client may deliver more than one file."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5,"description":"Accepted file kinds; empty or `any` means every file type the platform accepts."},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50,"description":"How many files the firm expects (a hint for the client, not enforced)."},"number":{"type":"string","maxLength":20,"description":"Outline number of the item, e.g. \"2.1.3\"."},"targetFolderId":{"type":"string","nullable":true,"format":"uuid","description":"Room-index folder the approved files go into; null = root."},"targetFolderTitle":{"type":"string","nullable":true},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"overdue":{"type":"boolean"},"authStrength":{"type":"string","nullable":true,"enum":["single","mfa",null],"description":"Strength of the client session that submitted the item (ADR-0013 D1 condition 1)."},"bsnAutoMask":{"type":"boolean","description":"The worker burns every BSN out of a delivered file before approval (ADR-0053)."}},"required":["id","sectionId","position","title","instructions","required","allowNotApplicable","dueDate","status","revision","visibility","files","notApplicable","decision","questions","key","showWhen","visible","answerKind","answerRules","answer","icon","footnote","allowMultiple","acceptedKinds","expectedCount","number","targetFolderId","targetFolderTitle","submittedAt","overdue","authStrength"],"description":"Request item as the firm sees it."}},"createdAt":{"type":"string","format":"date-time"},"sentAt":{"type":"string","nullable":true,"format":"date-time"},"openedAt":{"type":"string","nullable":true,"format":"date-time"},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"reminders":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"description":"Reminders sent so far (automatic and manual)."},"lastAt":{"type":"string","nullable":true,"format":"date-time"},"nextAt":{"type":"string","nullable":true,"format":"date-time","description":"Next automatic reminder; null when none is due."},"paused":{"type":"boolean"}},"required":["count","lastAt","nextAt","paused"],"description":"Reminder state (ADR-0053)."}},"required":["id","roomId","templateId","title","message","status","dueDate","recipient","portalUrl","parties","joint","periodContext","expiresAt","coverInstructions","displayStatus","progress","sections","items","createdAt","sentAt","openedAt","submittedAt","completedAt","updatedAt"],"description":"Document request (request-flow profile, firm view)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"No manage right on the room, or the room is not active.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown room or request (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/kvk/search":{"get":{"operationId":"searchKvk","summary":"Search the KvK trade register","description":"Search by company name or an eight-digit KvK number (PRF-10, ADR-0058). Only the search term is sent to the KvK; nothing is stored. Without an API key, local and test stacks answer from synthetic fixture companies (source fixture); online the route answers 503 SOURCE_UNAVAILABLE. client.create on the tenant. Writes kvk.searched (result count and query kind only, never the term).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","minLength":2,"maxLength":100,"description":"Company name, or an eight-digit KvK number (exact lookup)."},"required":true,"description":"Company name, or an eight-digit KvK number (exact lookup).","name":"q","in":"query"}],"responses":{"200":{"description":"Results.","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"kvkNumber":{"type":"string","pattern":"^[0-9]{8}$","description":"KvK number (eight digits, unformatted)."},"name":{"type":"string","minLength":1,"maxLength":300},"address":{"type":"object","nullable":true,"properties":{"street":{"type":"string","nullable":true,"maxLength":200,"description":"Street and house number."},"postalCode":{"type":"string","nullable":true,"maxLength":20},"city":{"type":"string","nullable":true,"maxLength":100}},"required":["street","postalCode","city"],"description":"Visiting address of the main establishment, as far as the register returns it."},"kind":{"type":"string","nullable":true,"enum":["main","branch","legal_entity",null],"description":"hoofdvestiging, nevenvestiging or rechtspersoon."}},"required":["kvkNumber","name","address","kind"],"description":"One company from the trade register."},"maxItems":20},"source":{"type":"string","enum":["kvk","fixture"],"description":"kvk = the KvK API; fixture = synthetic companies (local and test only)."}},"required":["results","source"],"description":"KvK search results (at most 20)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"May not create clients; guests and support.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"SOURCE_UNAVAILABLE: the KvK is not configured or not reachable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/auth/backchannel-logout":{"post":{"operationId":"backchannelLogout","summary":"Keycloak backchannel logout","description":"Server-to-server OIDC backchannel logout (ADR-0003 D4 step 6). Verifies the signed logout token against the realm JWKS and revokes every session of its `sid`. Public and CSRF-exempt by design: admission is the signed token, never a session cookie. Keycloak posts the token as `application/x-www-form-urlencoded`; the route also accepts the same `logout_token` field as `application/json` (T-260923-fc82 documents both instead of only the form encoding). Answers 200 with an empty body (also for an unknown `sid`) and 400 with a fixed body for a missing or invalid token, so it never reveals whether a session existed. A body over the 8 KiB `BODY_LIMIT_BYTES` is rejected with 413 before the handler runs.","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"logout_token":{"type":"string","minLength":1,"maxLength":8192,"description":"Signed OIDC backchannel logout token (JWT)."}},"required":["logout_token"],"description":"Keycloak backchannel logout request body."}},"application/json":{"schema":{"type":"object","properties":{"logout_token":{"type":"string","minLength":1,"maxLength":8192,"description":"Signed OIDC backchannel logout token (JWT)."}},"required":["logout_token"],"description":"Keycloak backchannel logout request body."}}}},"responses":{"200":{"description":"Logout token accepted; matching sessions revoked if any."},"400":{"description":"Missing or invalid logout token.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"413":{"description":"Body over the 8 KiB limit (framework body-limit rejection before the handler runs)."}}}},"/api/v1/auth/step-up":{"get":{"operationId":"startStepUp","summary":"Start the step-up (re-authentication) code flow","description":"Forces a fresh second factor for a privileged action (ADR-0003 D5): sets __Host-ddr_pre and redirects to Keycloak with prompt=login, max_age=0 and acr_values mfa|passkey. Needs an existing session; a signed-out caller answers 401 before any challenge is created.","parameters":[{"schema":{"type":"string","maxLength":2048,"description":"Relative path to return to after step-up."},"required":false,"description":"Relative path to return to after step-up.","name":"returnTo","in":"query"},{"schema":{"type":"string","enum":["mfa","passkey"],"description":"Requested authentication context."},"required":false,"description":"Requested authentication context.","name":"acr_values","in":"query"}],"responses":{"302":{"description":"Redirect to Keycloak."},"400":{"description":"Invalid request.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/find":{"get":{"operationId":"findInDocument","summary":"Find pages of one document that contain a term","description":"Find-in-document of the open viewer document (VIEW-04, UX-01). Requires `document.view` on the document; a caller that may not read it gets 404 (hidden stays hidden, PERM-02, exactly like the VIEW-12 page route - `document.view` denies an ordinary user/guest caller as not visible). Matches the **current version**'s stored page text (`document_page_text`: the PDF text layer plus OCRed pages, ADR-0011 D10/ADR-0036), so a document whose text was never indexed simply answers zero hits. Query syntax is shared with the content search: plain words are stemmed (Dutch, English, simple; diacritic-insensitive), `\"quoted phrases\"` keep word order, `word*` is a prefix, the last word also matches as a prefix while typing, and all words must match (AND). Answers the matching pages in ascending page order with a short `ts_headline` fragment per page, escaped with `<mark>` around the matches (ADR-0015 D4.3); `matchCount` is the number of matching pages and `truncated` says whether more matched than the `limit` returned. No original file, no full page body and no page image is served by this operation (ADR-0023: the viewer only ever gets watermarked page renders), and page text of a page the caller may not read is never returned. One `search.performed` audit event is recorded before the first byte with the scope, the match count and the filter codes (`in_document`, plus `phrase`/`prefix`), never the query text (ADR-0006 D4/ADR-0043 D1); when that write fails the route answers 503 `AUDIT_UNAVAILABLE` and serves nothing.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant of the path; a principal without one in this tenant answers 404."},"required":true,"description":"Tenant of the path; a principal without one in this tenant answers 404.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room of the document; a room the caller may not open answers 404."},"required":true,"description":"Room of the document; a room the caller may not open answers 404.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document to search inside."},"required":true,"description":"Document to search inside.","name":"documentId","in":"path"},{"schema":{"type":"string","minLength":2,"maxLength":200,"description":"Query text, trimmed, 2..200 characters; client data, never logged (UX-L25)."},"required":true,"description":"Query text, trimmed, 2..200 characters; client data, never logged (UX-L25).","name":"q","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":200,"description":"Page size, 1-200 (default 50)."},"required":false,"description":"Page size, 1-200 (default 50).","name":"limit","in":"query"}],"responses":{"200":{"description":"The pages of this document that contain the term, ascending, with a highlighted fragment per page.","content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid","description":"The document whose pages were searched."},"hits":{"type":"array","items":{"type":"object","properties":{"pageNo":{"type":"integer","minimum":1,"description":"1-based page number; the deep link of this hit is the VIEW-12 page route with it."},"snippet":{"type":"string","nullable":true,"description":"Escaped page text with <mark> around the matches, or null when the page produced no fragment. Never raw page text."}},"required":["pageNo","snippet"],"additionalProperties":false},"description":"Matching pages, ascending, at most `limit` of them."},"matchCount":{"type":"integer","minimum":0,"description":"Pages of this document that contain the term."},"truncated":{"type":"boolean","description":"True when more pages matched than were returned."},"textState":{"type":"string","nullable":true,"enum":["indexed","none","pending","failed",null],"description":"Whether the document holds searchable text (SRCH-05). Null when nothing was established, which is also what a document the caller cannot see answers, so the field is never a visibility oracle."},"textPages":{"type":"integer","minimum":0,"description":"Pages holding searchable text; meaningful on an empty answer, 0 unless `textState` is `indexed`."}},"required":["documentId","hits","matchCount","truncated","textState","textPages"],"additionalProperties":false}}}},"400":{"description":"Invalid request (code BAD_REQUEST): a query outside 2..200 characters or a `limit` outside the documented bounds.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: the room terms are still pending (code TERMS_NOT_ACCEPTED). Permission denials on the document itself are 404 (hidden stays hidden, PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"The tenant, room or document does not exist or is not visible to the caller (code NOT_FOUND, ADR-0005 §8, PERM-02). Guest existence is hidden the same way.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"Audit unavailable (code AUDIT_UNAVAILABLE): the read was not recorded, so nothing is served (ADR-0043 D1).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/settings":{"get":{"operationId":"getRoomSettings","summary":"Read room settings","description":"Reads the S-ROOM-14 room settings (MAT-06, DOC-04, ORG-07, PERM-12, VIEW-03): general room details with the read-only room type, whether index numbers are shown and placeholder visibility, the room-terms state with its acceptance count, the viewer/watermark defaults and the danger-zone entry-point flags. Guarded by the non-mutating `room.settings.read` (manage-level, users only), so the screen still loads in a frozen, closed or archived room (S-ROOM-14). 404 hides existence, including cross-tenant (PERM-02). Not audited by itself; the change below writes room.settings_changed with the changed setting codes only.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"Room settings.","content":{"application/json":{"schema":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"roomId":{"type":"string","format":"uuid","description":"Room id."},"name":{"type":"string","minLength":1,"maxLength":200,"description":"Room name (editable)."},"description":{"type":"string","nullable":true,"maxLength":2000,"description":"Free-text room description, or null."},"roomType":{"type":"string","enum":["client_portal","litigation"],"description":"Room type; read-only after creation."},"matterId":{"type":"string","nullable":true,"format":"uuid","description":"Linked matter, or null for a room without a matter."},"state":{"type":"string","enum":["active","frozen","closed","archived"],"description":"Room states visible through this API (destroying/destroyed are never listed)."},"showIndexNumbers":{"type":"boolean","description":"Whether index numbers are visible to guests (DOC-02/DOC-04); numbering stays position-derived either way."},"showPlaceholders":{"type":"boolean","description":"Whether placeholders (upload-flow item nodes) are visible in the index (DOC-04/INT-F08)."},"roomTerms":{"type":"object","properties":{"required":{"type":"boolean","description":"Whether a principal must accept the effective terms before access."},"effectiveVersionId":{"type":"string","nullable":true,"format":"uuid","description":"Effective terms version (room override or firm default); null when the firm has none."},"acceptanceCount":{"type":"integer","minimum":0,"description":"Internal principals that accepted the effective version (count only, no identities)."}},"required":["required","effectiveVersionId","acceptanceCount"],"description":"Room terms/NDA state (ORG-07)."},"viewerDefaults":{"type":"object","properties":{"watermarkOn":{"type":"boolean","description":"Watermark previews and downloads by default (PERM-12)."},"downloadAsWatermarkedPdf":{"type":"boolean","description":"New groups default to PDF only: the watermarked PDF, never the source file (PERM-12)."},"seeGroupMembers":{"type":"boolean","description":"Whether members of a group may see each other's names by default (PERM-12)."},"protection":{"type":"string","enum":["off","standard","strict"],"description":"Screenshot protection level external groups follow (ADR-0066). The server always sends it; absent = `standard`."}},"required":["watermarkOn","downloadAsWatermarkedPdf","seeGroupMembers"],"description":"Room-level viewer/watermark defaults that groups inherit (PERM-12)."},"dangerZone":{"type":"object","properties":{"canFreeze":{"type":"boolean","description":"The caller may freeze the room (T-260914-64db, MAT-10)."},"canClose":{"type":"boolean","description":"The caller may close the matter/room to read-only (MAT-11)."},"canRequestDestruction":{"type":"boolean","description":"The caller may request room destruction (T-260914-b2d9, ADR-0012)."}},"required":["canFreeze","canClose","canRequestDestruction"],"description":"Danger-zone entry-point flags; the screen hides the ones that are false."}},"required":["tenantId","roomId","name","description","roomType","matterId","state","showIndexNumbers","showPlaceholders","roomTerms","viewerDefaults","dangerZone"],"description":"Room settings for the S-ROOM-14 settings screen (MAT-06, DOC-04, ORG-07, PERM-12, VIEW-03)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `room.settings.read`: neither a firm role nor `manage` on the room root).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"patch":{"operationId":"updateRoomSettings","summary":"Update room settings","description":"Partially updates the S-ROOM-14 room settings; only the provided keys change. The room type is read-only after creation and unknown keys are rejected, so a client or document field cannot be smuggled in. Guarded by `room.settings.update`; the route enforces it per section. Emits `room.settings_changed` with the codes of the changed settings only (`setting_codes`), never their values and never content (ADR-0006; CLAUDE.md rule 1). 404 hides existence, including cross-tenant (PERM-02).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200,"description":"New room name."},"description":{"type":"string","nullable":true,"maxLength":2000,"description":"New description; null clears it."},"matterId":{"type":"string","nullable":true,"format":"uuid","description":"Link or re-link a matter; null clears the link."},"showIndexNumbers":{"type":"boolean","description":"Whether index numbers are visible to guests (DOC-02/DOC-04); numbering stays position-derived either way."},"showPlaceholders":{"type":"boolean"},"roomTerms":{"type":"object","properties":{"required":{"type":"boolean"},"versionId":{"type":"string","nullable":true,"format":"uuid","description":"Room terms version to enforce; null falls back to the firm default."}},"additionalProperties":false},"viewerDefaults":{"type":"object","properties":{"watermarkOn":{"type":"boolean","description":"Watermark previews and downloads by default (PERM-12)."},"downloadAsWatermarkedPdf":{"type":"boolean","description":"New groups default to PDF only: the watermarked PDF, never the source file (PERM-12)."},"seeGroupMembers":{"type":"boolean","description":"Whether members of a group may see each other's names by default (PERM-12)."},"protection":{"type":"string","enum":["off","standard","strict"],"description":"Screenshot protection level external groups follow (ADR-0066). The server always sends it; absent = `standard`."}},"additionalProperties":false}},"additionalProperties":false,"description":"Partial room settings update. Unknown keys are rejected, so `roomType` (read-only) and any client or document content cannot be sent."}}}},"responses":{"200":{"description":"The updated room settings.","content":{"application/json":{"schema":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"roomId":{"type":"string","format":"uuid","description":"Room id."},"name":{"type":"string","minLength":1,"maxLength":200,"description":"Room name (editable)."},"description":{"type":"string","nullable":true,"maxLength":2000,"description":"Free-text room description, or null."},"roomType":{"type":"string","enum":["client_portal","litigation"],"description":"Room type; read-only after creation."},"matterId":{"type":"string","nullable":true,"format":"uuid","description":"Linked matter, or null for a room without a matter."},"state":{"type":"string","enum":["active","frozen","closed","archived"],"description":"Room states visible through this API (destroying/destroyed are never listed)."},"showIndexNumbers":{"type":"boolean","description":"Whether index numbers are visible to guests (DOC-02/DOC-04); numbering stays position-derived either way."},"showPlaceholders":{"type":"boolean","description":"Whether placeholders (upload-flow item nodes) are visible in the index (DOC-04/INT-F08)."},"roomTerms":{"type":"object","properties":{"required":{"type":"boolean","description":"Whether a principal must accept the effective terms before access."},"effectiveVersionId":{"type":"string","nullable":true,"format":"uuid","description":"Effective terms version (room override or firm default); null when the firm has none."},"acceptanceCount":{"type":"integer","minimum":0,"description":"Internal principals that accepted the effective version (count only, no identities)."}},"required":["required","effectiveVersionId","acceptanceCount"],"description":"Room terms/NDA state (ORG-07)."},"viewerDefaults":{"type":"object","properties":{"watermarkOn":{"type":"boolean","description":"Watermark previews and downloads by default (PERM-12)."},"downloadAsWatermarkedPdf":{"type":"boolean","description":"New groups default to PDF only: the watermarked PDF, never the source file (PERM-12)."},"seeGroupMembers":{"type":"boolean","description":"Whether members of a group may see each other's names by default (PERM-12)."},"protection":{"type":"string","enum":["off","standard","strict"],"description":"Screenshot protection level external groups follow (ADR-0066). The server always sends it; absent = `standard`."}},"required":["watermarkOn","downloadAsWatermarkedPdf","seeGroupMembers"],"description":"Room-level viewer/watermark defaults that groups inherit (PERM-12)."},"dangerZone":{"type":"object","properties":{"canFreeze":{"type":"boolean","description":"The caller may freeze the room (T-260914-64db, MAT-10)."},"canClose":{"type":"boolean","description":"The caller may close the matter/room to read-only (MAT-11)."},"canRequestDestruction":{"type":"boolean","description":"The caller may request room destruction (T-260914-b2d9, ADR-0012)."}},"required":["canFreeze","canClose","canRequestDestruction"],"description":"Danger-zone entry-point flags; the screen hides the ones that are false."}},"required":["tenantId","roomId","name","description","roomType","matterId","state","showIndexNumbers","showPlaceholders","roomTerms","viewerDefaults","dangerZone"],"description":"Room settings for the S-ROOM-14 settings screen (MAT-06, DOC-04, ORG-07, PERM-12, VIEW-03)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `room.settings.update`: neither a firm role nor `manage` on the room root, or a required step-up is missing).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/pending-approvals":{"get":{"operationId":"listPendingApprovals","summary":"List the documents that wait for approval","description":"T-261005-7309 tenant-scoped pending-approval projection (contract T-261005-f09f): ids plus row metadata only (never document content) in stable document-id order, paged inside the authorized set behind an opaque cursor with 50-row pages. Requires `node.read` visibility and `upload.approve` per row; denied rows drop silently, never 403. A malformed cursor or limit answers 400; cross-tenant or invisible rooms answer 404 (PERM-02).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":50,"description":"Page size, 1-50 (default 50)."},"required":false,"description":"Page size, 1-50 (default 50).","name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":200,"description":"Opaque cursor from the previous page; omit it for the first page."},"required":false,"description":"Opaque cursor from the previous page; omit it for the first page.","name":"cursor","in":"query"}],"responses":{"200":{"description":"One page of the pending-approval queue.","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid","description":"The document that waits for approval."},"versionId":{"type":"string","format":"uuid","description":"The pending version."},"indexNodeId":{"type":"string","nullable":true,"format":"uuid","description":"The index node that shows this document."},"name":{"type":"string","nullable":true,"description":"Original file name of the pending version (client data)."},"uploadedBy":{"type":"string","nullable":true,"description":"Principal that uploaded the pending version."},"uploadedAt":{"type":"string","format":"date-time","description":"When the pending version was uploaded."}},"required":["documentId","versionId","indexNodeId","name","uploadedBy","uploadedAt"],"additionalProperties":false,"description":"One pending-approval row: ids plus row metadata only."},"description":"Authorized pending rows in stable document-id order."},"nextCursor":{"type":"string","nullable":true,"description":"Opaque cursor for the next page; null on the last page."}},"required":["items","nextCursor"],"additionalProperties":false,"description":"One page of the pending-approval queue."}}}},"400":{"description":"Invalid cursor or limit.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/audit-events":{"get":{"operationId":"listTenantAuditEvents","summary":"Query tenant audit events","description":"Queries firm-scoped audit events with filters and keyset pagination (T-261007-b900). Requires audit.read_tenant (firm_admin/compliance). Rows carry ids and codes only; display names come in labels, resolved at read time under the access of the reader (ADR-0006 D10). Includes the office-admin lifecycle rows (principal.blocked, principal.role_changed), which have no room.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Only events of this actor."},"required":false,"description":"Only events of this actor.","name":"principalId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Only events for this document/object."},"required":false,"description":"Only events for this document/object.","name":"documentId","in":"query"},{"schema":{"type":"string","maxLength":80,"pattern":"^([a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+|[a-z][a-z0-9_]*\\.)$","description":"Only events of this catalogue type (e.g. document.downloaded), or of one resource when the value ends in a dot (e.g. permission.)."},"required":false,"description":"Only events of this catalogue type (e.g. document.downloaded), or of one resource when the value ends in a dot (e.g. permission.).","name":"eventType","in":"query"},{"schema":{"type":"string","pattern":"^[A-Z][A-Z2-7]{7}$","description":"Only events carrying this watermark forensic id (details.watermark_id, T-260914-a10f): the 8-char id drawn in a downloaded PDF or viewed page, for looking up the matching audit event. Query surface only: report generation omits it, so a stored report is never silently scoped to one id."},"required":false,"description":"Only events carrying this watermark forensic id (details.watermark_id, T-260914-a10f): the 8-char id drawn in a downloaded PDF or viewed page, for looking up the matching audit event. Query surface only: report generation omits it, so a stored report is never silently scoped to one id.","name":"watermarkId","in":"query"},{"schema":{"type":"string","format":"date-time","description":"Inclusive lower bound (ISO-8601)."},"required":false,"description":"Inclusive lower bound (ISO-8601).","name":"from","in":"query"},{"schema":{"type":"string","format":"date-time","description":"Inclusive upper bound (ISO-8601)."},"required":false,"description":"Inclusive upper bound (ISO-8601).","name":"to","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Max rows (1-1000)."},"required":false,"description":"Max rows (1-1000).","name":"limit","in":"query"},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z_[0-9a-f-]{36}$","description":"Keyset cursor from a previous page (nextCursor); events query only."},"required":false,"description":"Keyset cursor from a previous page (nextCursor); events query only.","name":"cursor","in":"query"}],"responses":{"200":{"description":"Matching events with a verification summary.","content":{"application/json":{"schema":{"type":"object","properties":{"events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event id (the public reference, ADR-0006 D2)."},"seq":{"type":"integer","nullable":true,"description":"Chain sequence number; null while the event awaits sealing (seconds)."},"occurredAt":{"type":"string","format":"date-time","description":"When the event happened (ISO-8601)."},"recordedAt":{"type":"string","format":"date-time","description":"When the database recorded it (ISO-8601)."},"type":{"type":"string","description":"Catalogue event type (e.g. document.downloaded)."},"actorId":{"type":"string","description":"Acting principal id (empty for system and anonymous events)."},"actorKind":{"type":"string","enum":["user","guest","support","service","system","anonymous"],"description":"Kind of actor (ADR-0006 D2)."},"roomId":{"type":"string","nullable":true,"description":"Room id, null outside a room."},"documentId":{"type":"string","nullable":true,"description":"Document/object id, null without one."},"objectType":{"type":"string","nullable":true,"description":"Primary object type code."},"objectId":{"type":"string","nullable":true,"description":"Primary object id."},"details":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"nullable":true},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}]},"description":"Catalogue details: ids, codes and counts only (ADR-0006 D3)."},"ip":{"type":"string","nullable":true,"description":"Client address as seen by the API."},"device":{"type":"string","nullable":true,"description":"Normalised <browser>/<os> label."},"eventDigest":{"type":"string","nullable":true,"description":"SHA-256 event digest (hex), once sealed."},"hash":{"type":"string","nullable":true,"description":"Chain hash after this event (hex), once sealed."}},"required":["seq","occurredAt","type","actorId","roomId","documentId"],"description":"One audit event (ids and codes; names in labels)."},"description":"Matching events: newest first on the database path, chain order in memory."},"verification":{"type":"object","properties":{"status":{"type":"string","enum":["verified","failed"],"description":"Chain verification outcome."},"checkedAt":{"type":"string","format":"date-time","description":"When the check ran (ISO-8601)."},"eventCount":{"type":"integer","description":"Events covered by the check."},"firstSeq":{"type":"integer","nullable":true,"description":"First sequence covered, null when empty."},"lastSeq":{"type":"integer","nullable":true,"description":"Last sequence covered, null when empty."},"headSeq":{"type":"integer","nullable":true,"description":"Verified chain head sequence."},"headHash":{"type":"string","nullable":true,"description":"Verified chain head hash (hex)."},"failureCode":{"type":"string","nullable":true,"description":"ADR-0006 D8 failure code when failed."},"failedSeq":{"type":"integer","nullable":true,"description":"First failing sequence when failed."}},"required":["status","checkedAt","eventCount","firstSeq","lastSeq"],"description":"Verification summary attached to every report."},"labels":{"type":"object","properties":{"principals":{"type":"object","additionalProperties":{"type":"string"},"description":"Principal id -> display name."},"documents":{"type":"object","additionalProperties":{"type":"string"},"description":"Document id -> title."},"nodes":{"type":"object","additionalProperties":{"type":"string"},"description":"Index node id -> title."},"groups":{"type":"object","additionalProperties":{"type":"string"},"description":"Group id -> name."},"rooms":{"type":"object","additionalProperties":{"type":"string"},"description":"Room id -> name."}},"required":["principals","documents","nodes","groups","rooms"],"description":"Display names resolved at read time (never stored in audit rows)."},"nextCursor":{"type":"string","nullable":true,"description":"Cursor for the next (older) page."}},"required":["events","verification"],"description":"Tenant-scoped audit events (firm-wide lifecycle rows included) with a verification summary."}}}},"400":{"description":"Invalid filter.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (audit.read_tenant requires firm_admin/compliance).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, or a foreign tenant (PERM-02: reads as missing).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/security-contact":{"get":{"operationId":"getSecurityContact","summary":"Read the tenant security contact","description":"Reads the registered security/breach contact of the firm (OPS-05, ORG-03): the reachable role with its e-mail and phone, plus the last change timestamp. Answers the contact or an explicit null before the first save, never a fixture. Own tenant only; another tenant answers 404 (PERM-02). Navigation read: no audit event (ADR-0006 D4).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"The registered security contact, or null before the first save.","content":{"application/json":{"schema":{"type":"object","properties":{"contact":{"type":"object","nullable":true,"properties":{"role":{"type":"string","minLength":1,"maxLength":200,"description":"Reachable role, for example Security officer."},"email":{"type":"string","maxLength":320,"format":"email","description":"Contact e-mail address."},"phone":{"type":"string","minLength":1,"maxLength":50,"description":"Contact phone number."}},"required":["role","email","phone"],"description":"Registered contact, or null before the first save."},"updatedAt":{"type":"string","nullable":true,"format":"date-time","description":"Last change timestamp (ISO-8601), or null before the first save."}},"required":["contact","updatedAt"],"description":"Security contact read (`GET security-contact`)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"put":{"operationId":"updateSecurityContact","summary":"Replace the tenant security contact","description":"Full replace of the registered security/breach contact (firm admins only, with fresh MFA step-up, guarded by `tenant.settings.update` like the firm settings). Strict: the role, e-mail and phone are all required and unknown keys are rejected, so an invalid payload stores nothing (400). Own tenant only; another tenant answers 404 (PERM-02). Audited exactly like a firm settings change.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","minLength":1,"maxLength":200,"description":"Reachable role, for example Security officer."},"email":{"type":"string","maxLength":320,"format":"email","description":"Contact e-mail address."},"phone":{"type":"string","minLength":1,"maxLength":50,"description":"Contact phone number."}},"required":["role","email","phone"],"additionalProperties":false,"description":"Full replace of the security contact; strict so no extra field can be smuggled in."}}}},"responses":{"200":{"description":"Stored security contact.","content":{"application/json":{"schema":{"type":"object","properties":{"contact":{"type":"object","nullable":true,"properties":{"role":{"type":"string","minLength":1,"maxLength":200,"description":"Reachable role, for example Security officer."},"email":{"type":"string","maxLength":320,"format":"email","description":"Contact e-mail address."},"phone":{"type":"string","minLength":1,"maxLength":50,"description":"Contact phone number."}},"required":["role","email","phone"],"description":"Registered contact, or null before the first save."},"updatedAt":{"type":"string","nullable":true,"format":"date-time","description":"Last change timestamp (ISO-8601), or null before the first save."}},"required":["contact","updatedAt"],"description":"Security contact read (`GET security-contact`)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/security-notices":{"get":{"operationId":"listSecurityNotices","summary":"List the tenant security notices","description":"Lists the published security notices of the firm (OPS-05, ORG-03): ids, the closed initial/update/final kind, the publication day and the published body, newest first. Honestly empty when nothing is published, never fixture rows. Own tenant only; another tenant answers 404 (PERM-02). Navigation read: no audit event (ADR-0006 D4).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"Published security notices, newest first.","content":{"application/json":{"schema":{"type":"object","properties":{"notices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Stable notice-version id for list keys, selection and receipts."},"noticeId":{"type":"string","minLength":1,"maxLength":40,"description":"Human-readable notice id shown in the app, for example SEC-2026-0007."},"version":{"type":"integer","minimum":1,"description":"Version number within the notice id; 1 for the first publication, then 2, 3, ..."},"supersedes":{"type":"string","nullable":true,"format":"uuid","description":"Row id of the previous version of the same notice id, or null for version 1."},"kind":{"type":"string","enum":["initial","update","final"],"description":"How a published security notice progressed: first report, follow-up, or close-out."},"publishedAt":{"type":"string","format":"date","description":"Publication day (ISO calendar day)."},"body":{"type":"string","minLength":1,"maxLength":8000,"description":"Published incident body (authenticated app only)."}},"required":["id","noticeId","version","supersedes","kind","publishedAt","body"],"description":"One published security notice version of the tenant."},"description":"Published notices, newest first."}},"required":["notices"],"description":"Security notices list (`GET security-notices`)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"post":{"operationId":"publishSecurityNotice","summary":"Publish a new security notice version","description":"Publishes a new immutable security notice version for the firm (T-260914-bba1, OPS-05, ORG-03): the caller sends the notice id, kind, publication day and body, and the server appends the next version (same notice id, incremented version, supersedes link). A published version is never rewritten, so receipts keep pointing at exactly the version the admin saw. Firm admins only, with fresh MFA step-up, guarded by `tenant.settings.update` like the firm settings. Own tenant only; another tenant answers 404 (PERM-02). Audited exactly like a firm settings change (ids only, never the notice body). This is an in-app notice and receipt mechanism, not a legal-compliance guarantee.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"noticeId":{"type":"string","minLength":1,"maxLength":40,"description":"Human-readable notice id shown in the app, for example SEC-2026-0007."},"kind":{"type":"string","enum":["initial","update","final"],"description":"How a published security notice progressed: first report, follow-up, or close-out."},"publishedAt":{"type":"string","format":"date","description":"Publication day (ISO calendar day)."},"body":{"type":"string","minLength":1,"maxLength":8000,"description":"Published incident body (authenticated app only)."}},"required":["noticeId","kind","publishedAt","body"],"additionalProperties":false,"description":"Publish of a new security notice version; strict so no extra field can be smuggled in."}}}},"responses":{"200":{"description":"Stored published version.","content":{"application/json":{"schema":{"type":"object","properties":{"notice":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Stable notice-version id for list keys, selection and receipts."},"noticeId":{"type":"string","minLength":1,"maxLength":40,"description":"Human-readable notice id shown in the app, for example SEC-2026-0007."},"version":{"type":"integer","minimum":1,"description":"Version number within the notice id; 1 for the first publication, then 2, 3, ..."},"supersedes":{"type":"string","nullable":true,"format":"uuid","description":"Row id of the previous version of the same notice id, or null for version 1."},"kind":{"type":"string","enum":["initial","update","final"],"description":"How a published security notice progressed: first report, follow-up, or close-out."},"publishedAt":{"type":"string","format":"date","description":"Publication day (ISO calendar day)."},"body":{"type":"string","minLength":1,"maxLength":8000,"description":"Published incident body (authenticated app only)."}},"required":["id","noticeId","version","supersedes","kind","publishedAt","body"],"description":"Stored published version."}},"required":["notice"],"description":"Published security notice version (`POST security-notices`)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/security-notices/{noticeId}/receipts":{"get":{"operationId":"listSecurityNoticeReceipts","summary":"List read receipts of one security notice","description":"Lists the per-admin read receipts of one published notice (T-261007-dbcc): principal ids with marking times, sorted by principal id, honestly empty before any admin marks it read. Own tenant and known notice only; another tenant or an unknown notice answers 404 (PERM-02). Navigation read: no audit event. No notice bodies or contact PII in logs.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Security notice id."},"required":true,"description":"Security notice id.","name":"noticeId","in":"path"}],"responses":{"200":{"description":"Read receipts of the notice.","content":{"application/json":{"schema":{"type":"object","properties":{"receipts":{"type":"array","items":{"type":"object","properties":{"principalId":{"type":"string","minLength":1,"maxLength":200,"description":"Admin that marked the notice read (signed-in principal id)."},"readAt":{"type":"string","format":"date-time","description":"Marking time (ISO-8601)."}},"required":["principalId","readAt"],"description":"One per-admin read receipt of a security notice."},"description":"Read receipts, sorted by principal id."}},"required":["receipts"],"description":"Notice read receipts (`GET security-notices/{noticeId}/receipts`)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or notice (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"post":{"operationId":"markSecurityNoticeRead","summary":"Mark one security notice read for the current admin","description":"Stamps the current admin receipt for one published notice (T-261007-dbcc); re-marking is idempotent and keeps the first marking time. Every firm role that may read notices may mark its own read (`tenant.profile.read`). Own tenant and known notice only; another tenant or an unknown notice answers 404 (PERM-02). No audit event and no bodies or PII in logs.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Security notice id."},"required":true,"description":"Security notice id.","name":"noticeId","in":"path"}],"responses":{"200":{"description":"Stored receipt of the current admin.","content":{"application/json":{"schema":{"type":"object","properties":{"receipt":{"type":"object","properties":{"principalId":{"type":"string","minLength":1,"maxLength":200,"description":"Admin that marked the notice read (signed-in principal id)."},"readAt":{"type":"string","format":"date-time","description":"Marking time (ISO-8601)."}},"required":["principalId","readAt"],"description":"Stored receipt of the current admin."}},"required":["receipt"],"description":"Marked notice receipt (`POST security-notices/{noticeId}/receipts`)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or notice (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/review-items/bulk-approve":{"post":{"operationId":"bulkApproveReviewItems","summary":"Approve several review items in one request","description":"INT-F16 (T-260914-9aea): approve-only, one decision per item on its item node, at most 50 distinct items. Rights are re-checked per item (`flow_item.review`); denied rows are reported as skipped, never applied. Items with a document-validity rule are skipped with VALIDITY_RULE, rooms with pending terms with TERMS_NOT_ACCEPTED, unknown or cross-tenant items with NOT_FOUND (PERM-02). Every applied item goes through the same review path as the single-item route, so filing, version history and the per-item audit events are identical. Ids and codes only (never content).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"flowId":{"type":"string","format":"uuid"},"itemId":{"type":"string","format":"uuid"}},"required":["flowId","itemId"],"additionalProperties":false},"minItems":1,"maxItems":50,"description":"Items to approve; 1-50 entries, deduplicated by flowId:itemId."}},"required":["items"],"additionalProperties":false,"description":"Bulk approve request (INT-F16)."}}}},"responses":{"200":{"description":"Per-item outcome: applied items and skipped items with their reason code.","content":{"application/json":{"schema":{"type":"object","properties":{"approved":{"type":"array","items":{"type":"object","properties":{"flowId":{"type":"string","format":"uuid"},"itemId":{"type":"string","format":"uuid"}},"required":["flowId","itemId"],"additionalProperties":false,"description":"One approved item."},"description":"Items the caller approved."},"skipped":{"type":"array","items":{"type":"object","properties":{"flowId":{"type":"string","format":"uuid"},"itemId":{"type":"string","format":"uuid"},"code":{"type":"string","maxLength":64,"description":"Uppercase refusal code: NOT_FOUND, FORBIDDEN, TERMS_NOT_ACCEPTED, VALIDITY_RULE, INTERNAL."}},"required":["flowId","itemId","code"],"additionalProperties":false,"description":"One skipped item with its reason code."},"description":"Items left untouched, with the reason code."}},"required":["approved","skipped"],"additionalProperties":false,"description":"Bulk approve result (INT-F16)."}}}},"400":{"description":"Invalid body: missing items, more than 50, or a malformed id.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: no review permission at all (per-item denials are reported as skipped).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant (PERM-02 hides existence).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/uploads/{uploadSessionId}":{"post":{"operationId":"createTusUpload","summary":"Create a resumable (tus) upload session","description":"Authorizes `document.upload` on the target folder (or the room root) before touching session state, validates `Upload-Length` (the 5 GiB plaintext cap is enforced before any quota access) and `x-ddr-filename`, reserves the declared bytes on the tenant storage pool and answers 201 with the tus session headers. Replaying the creation for an open session of the same principal answers 200 with the current offset instead of resetting it and without reserving twice. Read-side refusals hide behind 404 (PERM-02); a member without an upload level is 403 and an exhausted pool or an over-cap length is 413. Writes `document_version.upload_started`. An optional `x-ddr-document-id` names an existing document in the same room that receives version n+1 (T-261008-2859): the creation authorizes `document.version.create` on its node like the single-request version upload instead of the folder check, and the completing PATCH finalizes the new version after re-checking it.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Client-chosen upload session id (the tus resource id); reused for the idempotent replay."},"required":true,"description":"Client-chosen upload session id (the tus resource id); reused for the idempotent replay.","name":"uploadSessionId","in":"path"},{"schema":{"type":"string","pattern":"^\\d{1,15}$","description":"Declared plaintext size in bytes (at most 5 GiB)."},"required":true,"description":"Declared plaintext size in bytes (at most 5 GiB).","name":"upload-length","in":"header"},{"schema":{"type":"string","minLength":1,"maxLength":1024,"description":"The file name, percent-encoded (encodeURIComponent). Client data: never logged."},"required":true,"description":"The file name, percent-encoded (encodeURIComponent). Client data: never logged.","name":"x-ddr-filename","in":"header"},{"schema":{"type":"string","maxLength":255,"description":"Optional media type; an unusable value finalizes with a null type like the single-request route."},"required":false,"description":"Optional media type; an unusable value finalizes with a null type like the single-request route.","name":"x-ddr-mime","in":"header"},{"schema":{"type":"string","format":"uuid","description":"Target folder; omitted means the room root. The completed version lands under it."},"required":false,"description":"Target folder; omitted means the room root. The completed version lands under it.","name":"x-ddr-index-node-id","in":"header"},{"schema":{"type":"string","format":"uuid","description":"Existing document in the same room that receives version n+1 instead of a first version (T-261008-2859). The creation authorizes document.version.create on its node like the single-request version upload; the completing PATCH repeats the header after a restart."},"required":false,"description":"Existing document in the same room that receives version n+1 instead of a first version (T-261008-2859). The creation authorizes document.version.create on its node like the single-request version upload; the completing PATCH repeats the header after a restart.","name":"x-ddr-document-id","in":"header"}],"responses":{"200":{"description":"Idempotent replay: the open session of this principal, current offset.","headers":{"tus-resumable":{"schema":{"type":"string","enum":["1.0.0"],"description":"The tus protocol version."},"required":true,"description":"The tus protocol version."},"location":{"schema":{"type":"string","description":"The tus resource URL the client keeps PATCHing (this request URL)."},"required":true,"description":"The tus resource URL the client keeps PATCHing (this request URL)."},"upload-offset":{"schema":{"type":"string","pattern":"^\\d{1,15}$","description":"Bytes accepted so far (0 on a fresh session)."},"required":true,"description":"Bytes accepted so far (0 on a fresh session)."},"upload-length":{"schema":{"type":"string","pattern":"^\\d{1,15}$","description":"The declared total length."},"required":true,"description":"The declared total length."}}},"201":{"description":"Created; the session is open at offset 0.","headers":{"tus-resumable":{"schema":{"type":"string","enum":["1.0.0"],"description":"The tus protocol version."},"required":true,"description":"The tus protocol version."},"location":{"schema":{"type":"string","description":"The tus resource URL the client keeps PATCHing (this request URL)."},"required":true,"description":"The tus resource URL the client keeps PATCHing (this request URL)."},"upload-offset":{"schema":{"type":"string","pattern":"^\\d{1,15}$","description":"Bytes accepted so far (0 on a fresh session)."},"required":true,"description":"Bytes accepted so far (0 on a fresh session)."},"upload-length":{"schema":{"type":"string","pattern":"^\\d{1,15}$","description":"The declared total length."},"required":true,"description":"The declared total length."}}},"400":{"description":"Missing or malformed Upload-Length, an unusable file name or a bad target.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no upload level on the target).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (cross-tenant, an invisible target or a session of another principal).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Read-only room.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"413":{"description":"Declared length over the 5 GiB cap, or the storage pool is exhausted.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"Too many concurrent sessions (SERVICE_UNAVAILABLE).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"head":{"operationId":"headTusUpload","summary":"Read the offset of a resumable (tus) upload session","description":"The current offset and declared length of a session this principal may upload to. Anything but the session owner's readable session is 404 (tus `404`), indistinguishable from an unknown session (PERM-02); cross-tenant and revoked rooms read as gone. No body.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Client-chosen upload session id (the tus resource id); reused for the idempotent replay."},"required":true,"description":"Client-chosen upload session id (the tus resource id); reused for the idempotent replay.","name":"uploadSessionId","in":"path"}],"responses":{"200":{"description":"The current offset and the declared length.","headers":{"tus-resumable":{"schema":{"type":"string","enum":["1.0.0"],"description":"The tus protocol version."},"required":true,"description":"The tus protocol version."},"upload-offset":{"schema":{"type":"string","pattern":"^\\d{1,15}$","description":"Bytes accepted so far."},"required":true,"description":"Bytes accepted so far."},"upload-length":{"schema":{"type":"string","pattern":"^\\d{1,15}$","description":"The declared total length."},"required":true,"description":"The declared total length."}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown, cross-tenant, another principal or no longer uploadable).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"delete":{"operationId":"deleteTusUpload","summary":"Terminate a resumable (tus) upload session","description":"Aborts the session and releases the creation-time pool reservation. An unknown session, a foreign tenant or another principal is 404 (PERM-02); a second termination of the same session is 404 as well (the resource is gone). Writes no audit event of its own.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Client-chosen upload session id (the tus resource id); reused for the idempotent replay."},"required":true,"description":"Client-chosen upload session id (the tus resource id); reused for the idempotent replay.","name":"uploadSessionId","in":"path"}],"responses":{"204":{"description":"Terminated; the reservation is released."},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown, cross-tenant, another principal or already terminated).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"patch":{"operationId":"patchTusUpload","summary":"Accept a resumable (tus) upload chunk","description":"Requires `Upload-Offset` to equal the session offset (409 OFFSET_MISMATCH otherwise, with the current offset) and `Content-Type: application/offset+octet-stream` (415 otherwise). Stages the bytes in arrival order and answers 204 with the new Upload-Offset. When the offset reaches the declared length the staged bytes finalize into the document, its version and the completed session in one tenant transaction, the tus URL is gone and the 204 carries the version receipt (`x-ddr-node-id`, `x-ddr-document-id`, `x-ddr-version-id`). A lost completion is replayed with an empty PATCH at the final offset, returning the identical receipt for the same principal; a foreign tenant, another principal, a non-empty chunk or a revoked uploader is 404 (PERM-02). A chunk over the declared length is 413.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Client-chosen upload session id (the tus resource id); reused for the idempotent replay."},"required":true,"description":"Client-chosen upload session id (the tus resource id); reused for the idempotent replay.","name":"uploadSessionId","in":"path"},{"schema":{"type":"string","pattern":"^\\d{1,15}$","description":"Byte offset the chunk starts at; it must equal the session offset (409 otherwise)."},"required":true,"description":"Byte offset the chunk starts at; it must equal the session offset (409 otherwise).","name":"upload-offset","in":"header"},{"schema":{"type":"string","enum":["application/offset+octet-stream"],"description":"The required tus chunk media type."},"required":true,"description":"The required tus chunk media type.","name":"content-type","in":"header"},{"schema":{"type":"string","format":"uuid","description":"Repeat of the creation-time new-version target (T-261008-2859): re-resolved and re-authorized on the completing PATCH when the creation binding was lost to a restart. A mismatch with a remembered binding is 400."},"required":false,"description":"Repeat of the creation-time new-version target (T-261008-2859): re-resolved and re-authorized on the completing PATCH when the creation binding was lost to a restart. A mismatch with a remembered binding is 400.","name":"x-ddr-document-id","in":"header"}],"requestBody":{"content":{"application/offset+octet-stream":{"schema":{"type":"string","description":"The raw chunk bytes at Upload-Offset."}}}},"responses":{"204":{"description":"Chunk accepted; the receipt headers are present when this chunk completed the upload.","headers":{"tus-resumable":{"schema":{"type":"string","enum":["1.0.0"],"description":"The tus protocol version."},"required":true,"description":"The tus protocol version."},"upload-offset":{"schema":{"type":"string","pattern":"^\\d{1,15}$","description":"The new or replayed offset."},"required":true,"description":"The new or replayed offset."},"x-ddr-node-id":{"schema":{"type":"string","format":"uuid","description":"Present on the completing chunk and its replay."},"required":false,"description":"Present on the completing chunk and its replay."},"x-ddr-document-id":{"schema":{"type":"string","format":"uuid","description":"Present on the completing chunk and its replay."},"required":false,"description":"Present on the completing chunk and its replay."},"x-ddr-version-id":{"schema":{"type":"string","format":"uuid","description":"Present on the completing chunk and its replay."},"required":false,"description":"Present on the completing chunk and its replay."}}},"400":{"description":"Missing or malformed Upload-Offset.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (unknown, cross-tenant, another principal or not replayable).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"OFFSET_MISMATCH: Upload-Offset differs from the session offset (current offset returned).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"413":{"description":"The chunk exceeds the declared length.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"415":{"description":"Content-Type is not application/offset+octet-stream.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/sso-status":{"get":{"operationId":"getSsoStatus","summary":"Read the firm's SSO status","description":"The firm-level SSO projection state plus the firm's e-mail domains with verification flags. Firm admin only (`tenant.settings.update`). Not callable with an API key.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"The SSO status.","content":{"application/json":{"schema":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid","description":"The caller tenant."},"configured":{"type":"boolean","description":"False when the firm has no SSO configuration row."},"config":{"type":"object","nullable":true,"properties":{"protocol":{"type":"string","enum":["oidc","saml"],"description":"The firm IdP protocol."},"domainMatching":{"type":"string","enum":["exact","subdomain"],"description":"Verified-domain routing mode."},"status":{"type":"string","enum":["draft","active","disabled"],"description":"Firm-level SSO projection state."},"requireLocalMfa":{"type":"boolean","description":"True when local MFA stays required beside SSO."},"jitProvisioning":{"type":"string","enum":["off","verified_domain"],"description":"Link-only by default; verified-domain JIT provisioning opt-in."},"idpAlias":{"type":"string","nullable":true,"minLength":1,"maxLength":128,"description":"Opaque IdP alias, or null when unset."}},"required":["protocol","domainMatching","status","requireLocalMfa","jitProvisioning","idpAlias"],"description":"The SSO configuration, or null when unconfigured."},"domains":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"maxLength":253,"description":"Canonical firm e-mail domain (lower-case A-label)."},"verified":{"type":"boolean","description":"True when the domain is verified for routing/JIT."}},"required":["domain","verified"],"description":"One firm e-mail domain."},"description":"The firm's e-mail domains with verification flags."}},"required":["tenantId","configured","config","domains"],"description":"Firm SSO status."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: not a firm admin; API-key callers never (session-only).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/sso-config":{"put":{"operationId":"putSsoConfig","summary":"Upsert the firm's SSO configuration","description":"Upserts the `tenant_sso_config` row (no IdP writes, no verification flow). Firm admin only (`tenant.settings.update`). Not callable with an API key.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"protocol":{"type":"string","enum":["oidc","saml"],"description":"The firm IdP protocol."},"domainMatching":{"type":"string","enum":["exact","subdomain"],"description":"Verified-domain routing mode."},"status":{"type":"string","enum":["draft","active","disabled"],"description":"Firm-level SSO projection state."},"requireLocalMfa":{"type":"boolean"},"jitProvisioning":{"type":"string","enum":["off","verified_domain"],"description":"Link-only by default; verified-domain JIT provisioning opt-in."},"idpAlias":{"type":"string","nullable":true,"minLength":1,"maxLength":128}},"required":["protocol","domainMatching","status","requireLocalMfa","jitProvisioning","idpAlias"],"description":"Firm SSO configuration upsert."}}}},"responses":{"200":{"description":"The updated SSO status.","content":{"application/json":{"schema":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid","description":"The caller tenant."},"configured":{"type":"boolean","description":"False when the firm has no SSO configuration row."},"config":{"type":"object","nullable":true,"properties":{"protocol":{"type":"string","enum":["oidc","saml"],"description":"The firm IdP protocol."},"domainMatching":{"type":"string","enum":["exact","subdomain"],"description":"Verified-domain routing mode."},"status":{"type":"string","enum":["draft","active","disabled"],"description":"Firm-level SSO projection state."},"requireLocalMfa":{"type":"boolean","description":"True when local MFA stays required beside SSO."},"jitProvisioning":{"type":"string","enum":["off","verified_domain"],"description":"Link-only by default; verified-domain JIT provisioning opt-in."},"idpAlias":{"type":"string","nullable":true,"minLength":1,"maxLength":128,"description":"Opaque IdP alias, or null when unset."}},"required":["protocol","domainMatching","status","requireLocalMfa","jitProvisioning","idpAlias"],"description":"The SSO configuration, or null when unconfigured."},"domains":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"maxLength":253,"description":"Canonical firm e-mail domain (lower-case A-label)."},"verified":{"type":"boolean","description":"True when the domain is verified for routing/JIT."}},"required":["domain","verified"],"description":"One firm e-mail domain."},"description":"The firm's e-mail domains with verification flags."}},"required":["tenantId","configured","config","domains"],"description":"Firm SSO status."}}}},"400":{"description":"Invalid body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: not a firm admin; API-key callers never (session-only).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/sso-domains":{"post":{"operationId":"postSsoDomain","summary":"Add one firm e-mail domain","description":"Adds one canonical domain row, always unverified and therefore not routable until confirmed. Firm admin only (`tenant.settings.update`). Not callable with an API key.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"maxLength":253,"description":"Firm e-mail domain (canonicalised server-side)."}},"required":["domain"],"description":"Add one firm e-mail domain."}}}},"responses":{"201":{"description":"The added domain.","content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"maxLength":253,"description":"Canonical firm e-mail domain (lower-case A-label)."},"verified":{"type":"boolean","description":"True when the domain is verified for routing/JIT."}},"required":["domain","verified"],"description":"One firm e-mail domain."}}}},"400":{"description":"Invalid domain.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: not a firm admin; API-key callers never (session-only).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Domain already present.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/sso-domains/{domain}":{"delete":{"operationId":"deleteSsoDomain","summary":"Remove one firm e-mail domain","description":"Removes one domain row. Firm admin only (`tenant.settings.update`). Not callable with an API key.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"domain","in":"path"}],"responses":{"204":{"description":"Removed."},"400":{"description":"Invalid domain.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: not a firm admin; API-key callers never (session-only).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/sso-domains/{domain}/verification-challenge":{"post":{"operationId":"postSsoDomainVerificationChallenge","summary":"Issue the DNS TXT challenge for a domain","description":"Returns the DNS TXT record name/value the firm publishes to prove control of an own-tenant domain. The value is public by design. Firm admin only (`tenant.settings.update`). Not callable with an API key.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"domain","in":"path"}],"responses":{"200":{"description":"The challenge.","content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"maxLength":253},"method":{"type":"string","enum":["dns_txt"]},"recordName":{"type":"string","minLength":1,"maxLength":280},"token":{"type":"string","minLength":1,"maxLength":256}},"required":["domain","method","recordName","token"],"description":"DNS TXT challenge for one firm e-mail domain."}}}},"400":{"description":"Invalid domain.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: not a firm admin; API-key callers never (session-only).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/sso-domains/{domain}/verification":{"post":{"operationId":"postSsoDomainVerification","summary":"Confirm the DNS TXT challenge for a domain","description":"Flips `domain_verified` when the submitted token matches the issued challenge; a wrong token answers 400 and leaves the domain unroutable. Firm admin only (`tenant.settings.update`). Not callable with an API key.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","minLength":1},"required":true,"name":"domain","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","minLength":1,"maxLength":256}},"required":["token"],"description":"Confirmation of the issued DNS TXT challenge."}}}},"responses":{"200":{"description":"The confirmed domain.","content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"maxLength":253},"verified":{"type":"boolean","enum":[true]},"method":{"type":"string","enum":["dns_txt"]}},"required":["domain","verified","method"],"description":"A confirmed (routable) firm e-mail domain."}}}},"400":{"description":"Invalid domain or token.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: not a firm admin; API-key callers never (session-only).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/billing/plan":{"post":{"operationId":"changeBillingPlan","summary":"Change the firm subscription plan","description":"Sets the plan code (annual billing); flex cancels the subscription back to pay-per-file. Idempotent: the same plan answers 200 with no write. Firm admin with fresh MFA only (`billing.manage`). Writes `billing.plan_changed`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"plan":{"type":"string","enum":["flex","basis","pro","enterprise"],"description":"The new plan (flex cancels the subscription)."}},"required":["plan"],"additionalProperties":false,"description":"Change the firm subscription plan."}}}},"responses":{"200":{"description":"The billing overview with the new plan.","content":{"application/json":{"schema":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid"},"plan":{"type":"string","enum":["flex","basis","pro","enterprise"],"description":"Subscription plan (PLAN §7.3): flex, basis, pro or enterprise."},"seats":{"type":"object","properties":{"professionals":{"type":"integer","minimum":0,"maximum":100000,"description":"Billable seats: every active office member counts once, whatever their roles or email domain."},"supportUsers":{"type":"integer","minimum":0,"maximum":100000,"description":"Informative sub-count: active members holding only support roles (secretary, back office). Already included in professionals; never priced separately."},"guests":{"type":"integer","minimum":0,"maximum":100000,"description":"Active guests: free and unlimited, never billed."},"byRole":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["firm_admin","lawyer","legal_assistant","secretary","billing","adviser","back_office","compliance"],"description":"Firm role (ADR-0005 §3)."},"users":{"type":"integer","minimum":0,"maximum":100000,"description":"Active firm users holding this role (a user may hold several)."}},"required":["role","users"],"description":"Active firm users per role."}}},"required":["professionals","supportUsers","guests","byRole"],"description":"Seats counted from the active firm users; guests are listed but free."},"activeFiles":{"type":"integer","minimum":0,"maximum":100000,"description":"Active rooms (the Flex unit)."},"quote":{"type":"object","properties":{"plan":{"type":"string","enum":["flex","basis","pro","enterprise"],"description":"Subscription plan (PLAN §7.3): flex, basis, pro or enterprise."},"professionals":{"type":"integer","minimum":0,"maximum":100000,"description":"Billable members: every active office member counts once."},"activeFiles":{"type":"integer","minimum":0,"maximum":100000,"description":"Active files (rooms); only priced on Flex."},"tiers":{"type":"array","items":{"type":"object","properties":{"from":{"type":"integer","minimum":1,"description":"First member of the bracket."},"to":{"type":"integer","nullable":true,"minimum":1,"description":"Last member of the bracket; null = and up."},"professionals":{"type":"integer","minimum":0,"maximum":100000,"description":"Members billed in this bracket."},"unitAnnualCents":{"type":"integer","minimum":0,"description":"Price per member per year in this bracket (excl. VAT)."},"annualCents":{"type":"integer","minimum":0,"description":"professionals x unitAnnualCents."},"monthlyCents":{"type":"integer","minimum":0,"description":"Monthly share of this line (annualCents / 12, rounded)."}},"required":["from","to","professionals","unitAnnualCents","annualCents","monthlyCents"],"description":"One graduated price bracket (PLAN §7.3, approved 9 October 2026)."},"description":"Graduated brackets with at least one member."},"extras":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["support_users","enterprise_pack","flex_files"],"description":"Extra line: the Enterprise pack or Flex files (support_users is kept for wire compat)."},"quantity":{"type":"integer","minimum":0,"maximum":100000},"unitCents":{"type":"integer","minimum":0,"description":"Unit price excl. VAT (per year or per file, see `unit`)."},"unit":{"type":"string","enum":["month","year","file"],"description":"What the unit price is charged per."},"monthlyCents":{"type":"integer","minimum":0,"description":"Monthly equivalent excl. VAT (a yearly or one-off amount / 12, rounded)."},"annualCents":{"type":"integer","minimum":0,"description":"Yearly amount excl. VAT."}},"required":["code","quantity","unitCents","unit","monthlyCents","annualCents"],"description":"A price line outside the member brackets (PLAN §7.3)."}},"monthly":{"type":"object","properties":{"exclVatCents":{"type":"integer","minimum":0},"vatCents":{"type":"integer","minimum":0},"inclVatCents":{"type":"integer","minimum":0}},"required":["exclVatCents","vatCents","inclVatCents"],"description":"Per month, billed annually."},"annual":{"type":"object","properties":{"exclVatCents":{"type":"integer","minimum":0},"vatCents":{"type":"integer","minimum":0},"inclVatCents":{"type":"integer","minimum":0}},"required":["exclVatCents","vatCents","inclVatCents"],"description":"Per year (exact graduated total with annual billing)."},"monthlyBilling":{"type":"object","properties":{"exclVatCents":{"type":"integer","minimum":0},"vatCents":{"type":"integer","minimum":0},"inclVatCents":{"type":"integer","minimum":0}},"required":["exclVatCents","vatCents","inclVatCents"],"description":"Per month when billed monthly (annual seat amount / 12 x 19/15)."},"averagePerProfessionalCents":{"type":"integer","nullable":true,"minimum":0,"description":"Brackets only: average price per member per month; null without members."},"includedStorageBytes":{"type":"integer","minimum":0,"description":"Storage the plan adds to the organisation pool (decimal bytes)."}},"required":["plan","professionals","activeFiles","tiers","extras","monthly","annual","monthlyBilling","averagePerProfessionalCents","includedStorageBytes"],"description":"The current price, computed from the seats above."},"storage":{"type":"object","properties":{"poolBytes":{"type":"integer","nullable":true,"minimum":0,"description":"Configured organisation pool (storage pool row); null before the first upload."},"includedBytes":{"type":"integer","minimum":0,"description":"Pool size the plan includes for these seats."},"usedHotBytes":{"type":"integer","minimum":0},"usedArchiveBytes":{"type":"integer","minimum":0},"reservedBytes":{"type":"integer","minimum":0},"state":{"type":"string","nullable":true,"enum":["ok","warning","grace","blocked",null],"description":"Derived pool state (ADR-0007 D10): ok, warning at 80 %, grace, or blocked."},"roomCount":{"type":"integer","minimum":0,"maximum":100000,"description":"Rooms that store at least one byte."},"largestRooms":{"type":"array","items":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true,"description":"Firm-visible room name. Never a document or file name, never content."},"bytes":{"type":"integer","minimum":0,"description":"Stored originals incl. all versions (plaintext bytes)."}},"required":["roomId","name","bytes"],"description":"Storage of one room (DOC-23)."},"maxItems":8}},"required":["poolBytes","includedBytes","usedHotBytes","usedArchiveBytes","reservedBytes","state","roomCount","largestRooms"],"description":"The organisation storage pool (BILL-05): one pool, no limit per user, room or file."},"invoices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"]},"maxItems":0,"description":"Always empty until payments are active (Mollie, BILL-03, deferred)."},"paymentsActive":{"type":"boolean","enum":[false],"description":"No payment provider is connected yet."},"generatedAt":{"type":"string","format":"date-time"}},"required":["tenantId","plan","seats","activeFiles","quote","storage","invoices","paymentsActive","generatedAt"],"description":"Beheer > Abonnement en gebruik: plan, seats, price and storage (BILL-01/05/07)."}}}},"400":{"description":"Invalid plan.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out (or fresh MFA required: 401 STEP_UP_REQUIRED).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: not a firm admin (guests, support, compliance and API keys never; session-only commercial act).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/trial/signup":{"post":{"operationId":"trialSignup","summary":"Request verified account setup","description":"Neutral receipt for new/existing identities; sends pending setup actions only. Does not provision a tenant or reset an established account.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","maxLength":320,"format":"email"},"locale":{"type":"string","enum":["nl","en"]}},"required":["email"]}}}},"responses":{"202":{"description":"Check email or sign in with an existing account.","content":{"application/json":{"schema":{"type":"object","properties":{"accepted":{"type":"boolean","enum":[true]}},"required":["accepted"]}}}},"400":{"description":"Invalid input."},"403":{"description":"Business email required."},"404":{"description":"Not found (including cross-tenant) or not a trial office.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Too many attempts."}}}},"/api/v1/trial/complete":{"post":{"operationId":"completeTrialRegistration","summary":"Create the authenticated owner’s trial office","description":"Requires own enabled verified Keycloak identity and fresh MFA. No email or subject in the body can select another owner. Idempotent; existing non-trial offices are not adopted.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"firmName":{"type":"string","minLength":1,"maxLength":200},"locale":{"type":"string","enum":["nl","en"]},"preset":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,79}$"}},"required":["firmName"]}}}},"responses":{"200":{"description":"Existing own trial office.","content":{"application/json":{"schema":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid"},"fresh":{"type":"boolean"}},"required":["tenantId","fresh"]}}}},"201":{"description":"New office.","content":{"application/json":{"schema":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid"},"fresh":{"type":"boolean"}},"required":["tenantId","fresh"]}}}},"400":{"description":"Invalid office name or unavailable starter.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: not a firm admin with fresh MFA (guests, support and stale sessions never).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant) or not a trial office.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/trial/convert":{"post":{"operationId":"convertTrial","summary":"Convert the trial office to a paid plan","description":"Stamps `trial_converted_at`, sets the plan and writes `trial.converted`. Flex is refused (stays a trial); an already converted office gets its current overview back. Firm admin with fresh MFA only (`billing.manage`).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"plan":{"type":"string","enum":["basis","pro","enterprise"],"description":"The paid plan (flex is refused: converting to flex stays a trial)."}},"required":["plan"],"additionalProperties":false,"description":"Convert the trial office to a paid plan."}}}},"responses":{"200":{"description":"The billing overview with the new plan.","content":{"application/json":{"schema":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid"},"plan":{"type":"string","enum":["flex","basis","pro","enterprise"],"description":"Subscription plan (PLAN §7.3): flex, basis, pro or enterprise."},"seats":{"type":"object","properties":{"professionals":{"type":"integer","minimum":0,"maximum":100000,"description":"Billable seats: every active office member counts once, whatever their roles or email domain."},"supportUsers":{"type":"integer","minimum":0,"maximum":100000,"description":"Informative sub-count: active members holding only support roles (secretary, back office). Already included in professionals; never priced separately."},"guests":{"type":"integer","minimum":0,"maximum":100000,"description":"Active guests: free and unlimited, never billed."},"byRole":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["firm_admin","lawyer","legal_assistant","secretary","billing","adviser","back_office","compliance"],"description":"Firm role (ADR-0005 §3)."},"users":{"type":"integer","minimum":0,"maximum":100000,"description":"Active firm users holding this role (a user may hold several)."}},"required":["role","users"],"description":"Active firm users per role."}}},"required":["professionals","supportUsers","guests","byRole"],"description":"Seats counted from the active firm users; guests are listed but free."},"activeFiles":{"type":"integer","minimum":0,"maximum":100000,"description":"Active rooms (the Flex unit)."},"quote":{"type":"object","properties":{"plan":{"type":"string","enum":["flex","basis","pro","enterprise"],"description":"Subscription plan (PLAN §7.3): flex, basis, pro or enterprise."},"professionals":{"type":"integer","minimum":0,"maximum":100000,"description":"Billable members: every active office member counts once."},"activeFiles":{"type":"integer","minimum":0,"maximum":100000,"description":"Active files (rooms); only priced on Flex."},"tiers":{"type":"array","items":{"type":"object","properties":{"from":{"type":"integer","minimum":1,"description":"First member of the bracket."},"to":{"type":"integer","nullable":true,"minimum":1,"description":"Last member of the bracket; null = and up."},"professionals":{"type":"integer","minimum":0,"maximum":100000,"description":"Members billed in this bracket."},"unitAnnualCents":{"type":"integer","minimum":0,"description":"Price per member per year in this bracket (excl. VAT)."},"annualCents":{"type":"integer","minimum":0,"description":"professionals x unitAnnualCents."},"monthlyCents":{"type":"integer","minimum":0,"description":"Monthly share of this line (annualCents / 12, rounded)."}},"required":["from","to","professionals","unitAnnualCents","annualCents","monthlyCents"],"description":"One graduated price bracket (PLAN §7.3, approved 9 October 2026)."},"description":"Graduated brackets with at least one member."},"extras":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["support_users","enterprise_pack","flex_files"],"description":"Extra line: the Enterprise pack or Flex files (support_users is kept for wire compat)."},"quantity":{"type":"integer","minimum":0,"maximum":100000},"unitCents":{"type":"integer","minimum":0,"description":"Unit price excl. VAT (per year or per file, see `unit`)."},"unit":{"type":"string","enum":["month","year","file"],"description":"What the unit price is charged per."},"monthlyCents":{"type":"integer","minimum":0,"description":"Monthly equivalent excl. VAT (a yearly or one-off amount / 12, rounded)."},"annualCents":{"type":"integer","minimum":0,"description":"Yearly amount excl. VAT."}},"required":["code","quantity","unitCents","unit","monthlyCents","annualCents"],"description":"A price line outside the member brackets (PLAN §7.3)."}},"monthly":{"type":"object","properties":{"exclVatCents":{"type":"integer","minimum":0},"vatCents":{"type":"integer","minimum":0},"inclVatCents":{"type":"integer","minimum":0}},"required":["exclVatCents","vatCents","inclVatCents"],"description":"Per month, billed annually."},"annual":{"type":"object","properties":{"exclVatCents":{"type":"integer","minimum":0},"vatCents":{"type":"integer","minimum":0},"inclVatCents":{"type":"integer","minimum":0}},"required":["exclVatCents","vatCents","inclVatCents"],"description":"Per year (exact graduated total with annual billing)."},"monthlyBilling":{"type":"object","properties":{"exclVatCents":{"type":"integer","minimum":0},"vatCents":{"type":"integer","minimum":0},"inclVatCents":{"type":"integer","minimum":0}},"required":["exclVatCents","vatCents","inclVatCents"],"description":"Per month when billed monthly (annual seat amount / 12 x 19/15)."},"averagePerProfessionalCents":{"type":"integer","nullable":true,"minimum":0,"description":"Brackets only: average price per member per month; null without members."},"includedStorageBytes":{"type":"integer","minimum":0,"description":"Storage the plan adds to the organisation pool (decimal bytes)."}},"required":["plan","professionals","activeFiles","tiers","extras","monthly","annual","monthlyBilling","averagePerProfessionalCents","includedStorageBytes"],"description":"The current price, computed from the seats above."},"storage":{"type":"object","properties":{"poolBytes":{"type":"integer","nullable":true,"minimum":0,"description":"Configured organisation pool (storage pool row); null before the first upload."},"includedBytes":{"type":"integer","minimum":0,"description":"Pool size the plan includes for these seats."},"usedHotBytes":{"type":"integer","minimum":0},"usedArchiveBytes":{"type":"integer","minimum":0},"reservedBytes":{"type":"integer","minimum":0},"state":{"type":"string","nullable":true,"enum":["ok","warning","grace","blocked",null],"description":"Derived pool state (ADR-0007 D10): ok, warning at 80 %, grace, or blocked."},"roomCount":{"type":"integer","minimum":0,"maximum":100000,"description":"Rooms that store at least one byte."},"largestRooms":{"type":"array","items":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true,"description":"Firm-visible room name. Never a document or file name, never content."},"bytes":{"type":"integer","minimum":0,"description":"Stored originals incl. all versions (plaintext bytes)."}},"required":["roomId","name","bytes"],"description":"Storage of one room (DOC-23)."},"maxItems":8}},"required":["poolBytes","includedBytes","usedHotBytes","usedArchiveBytes","reservedBytes","state","roomCount","largestRooms"],"description":"The organisation storage pool (BILL-05): one pool, no limit per user, room or file."},"invoices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"]},"maxItems":0,"description":"Always empty until payments are active (Mollie, BILL-03, deferred)."},"paymentsActive":{"type":"boolean","enum":[false],"description":"No payment provider is connected yet."},"generatedAt":{"type":"string","format":"date-time"}},"required":["tenantId","plan","seats","activeFiles","quote","storage","invoices","paymentsActive","generatedAt"],"description":"Beheer > Abonnement en gebruik: plan, seats, price and storage (BILL-01/05/07)."}}}},"400":{"description":"Invalid plan.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: not a firm admin with fresh MFA (guests, support and stale sessions never).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant) or not a trial office.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/hand-off-packages":{"post":{"operationId":"createHandoffPackage","summary":"Enqueue a hand-off package export of one room for a recipient profile","description":"Enqueues one hand-off package (PRF-07 / TPRF-04): the room is exported for one external recipient profile (first profile `hdn`, the lender/HDN aanleverpakket). Requires `room.export.download` (manage on the room root, firm users only). The route only writes the row and its `handoff.export.build` job in one transaction and answers 202; the worker renders the delivered PDF/A-2b renditions (ADR-0038), writes the hash manifest and receipt and records `export.package.created`. A file that cannot be delivered for the profile fails the export honestly (a stable `failureCode`); the API path carries no local converter. At most three of the caller's exports may be in progress. Responses carry ids, dates, counts, codes and, once built, the manifest/receipt (ids, paths and hashes only) — never content.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"profile":{"type":"string","enum":["hdn"]},"recipient":{"type":"string","minLength":1,"maxLength":200,"description":"Recipient label."}},"required":["profile","recipient"],"additionalProperties":false,"description":"Ask for a hand-off package of one room for one recipient profile."}}}},"responses":{"202":{"description":"Queued hand-off package export.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"profile":{"type":"string","enum":["hdn","closing"],"description":"Recipient export profile (HDN/lender first)."},"recipient":{"type":"string","minLength":1,"maxLength":200},"status":{"type":"string","enum":["queued","building","ready","failed"],"description":"Lifecycle status of one hand-off package export."},"manifest":{"type":"object","nullable":true,"properties":{"format":{"type":"string","enum":["ddr-handoff/1"]},"profile":{"type":"string","enum":["hdn","closing"],"description":"Recipient export profile (HDN/lender first)."},"tenantId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"generatedAt":{"type":"string","format":"date-time","description":"Manifest generation time (UTC, ISO-8601)."},"itemCount":{"type":"integer","minimum":0},"totalBytes":{"type":"integer","minimum":0},"manifestSha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"SHA-256 over the manifest content excluding this field."},"items":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","minLength":1,"maxLength":512},"sha256Hex":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"Lowercase hex SHA-256 of the exact bytes."},"sizeBytes":{"type":"integer","minimum":0},"documentId":{"type":"string","format":"uuid"},"versionId":{"type":"string","format":"uuid"},"nodeId":{"type":"string","nullable":true,"format":"uuid"}},"required":["path","sha256Hex","sizeBytes","documentId","versionId","nodeId"],"description":"One delivered file (ids, path and hash only)."},"description":"Delivered files, in package order."}},"required":["format","profile","tenantId","roomId","generatedAt","itemCount","totalBytes","manifestSha256","items"],"description":"Hash manifest of one hand-off package."},"receipt":{"type":"object","nullable":true,"properties":{"format":{"type":"string","enum":["ddr-handoff-receipt/1"]},"profile":{"type":"string","enum":["hdn","closing"],"description":"Recipient export profile (HDN/lender first)."},"tenantId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"recipient":{"type":"string","minLength":1,"maxLength":200,"description":"Who the package goes to."},"generatedAt":{"type":"string","format":"date-time","description":"Receipt generation time (UTC, ISO-8601)."},"itemCount":{"type":"integer","minimum":0},"totalBytes":{"type":"integer","minimum":0},"manifestSha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"The manifest this receipt covers."}},"required":["format","profile","tenantId","roomId","recipient","generatedAt","itemCount","totalBytes","manifestSha256"],"description":"Receipt for one hand-off package (ids, counts and hash only)."},"failureCode":{"type":"string","nullable":true,"pattern":"^[A-Z][A-Z0-9_]{0,62}$"},"sizeBytes":{"type":"integer","nullable":true,"minimum":0},"createdAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","format":"date-time"}},"required":["id","roomId","profile","recipient","status","manifest","receipt","failureCode","sizeBytes","createdAt","completedAt","expiresAt"],"description":"One hand-off package export (ids, dates, counts and the built manifest plus receipt)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown room, no manage right on the room root, a guest or a support session (including cross-tenant, PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"RATE_LIMITED: three of the caller's exports are already in progress.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"get":{"operationId":"listHandoffPackages","summary":"List the caller's hand-off package exports of one room","description":"Lists the caller's own hand-off package exports in this room, newest first (PRF-07 / TPRF-04). Requires `room.export.download` (manage on the room root, firm users only). Honestly empty when nothing was requested; never another person's exports. Ids, dates, counts, codes and the built manifest/receipt (ids, paths and hashes only) — never content.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"The caller's hand-off package exports of this room, newest first.","content":{"application/json":{"schema":{"type":"object","properties":{"exports":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"profile":{"type":"string","enum":["hdn","closing"],"description":"Recipient export profile (HDN/lender first)."},"recipient":{"type":"string","minLength":1,"maxLength":200},"status":{"type":"string","enum":["queued","building","ready","failed"],"description":"Lifecycle status of one hand-off package export."},"manifest":{"type":"object","nullable":true,"properties":{"format":{"type":"string","enum":["ddr-handoff/1"]},"profile":{"type":"string","enum":["hdn","closing"],"description":"Recipient export profile (HDN/lender first)."},"tenantId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"generatedAt":{"type":"string","format":"date-time","description":"Manifest generation time (UTC, ISO-8601)."},"itemCount":{"type":"integer","minimum":0},"totalBytes":{"type":"integer","minimum":0},"manifestSha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"SHA-256 over the manifest content excluding this field."},"items":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","minLength":1,"maxLength":512},"sha256Hex":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"Lowercase hex SHA-256 of the exact bytes."},"sizeBytes":{"type":"integer","minimum":0},"documentId":{"type":"string","format":"uuid"},"versionId":{"type":"string","format":"uuid"},"nodeId":{"type":"string","nullable":true,"format":"uuid"}},"required":["path","sha256Hex","sizeBytes","documentId","versionId","nodeId"],"description":"One delivered file (ids, path and hash only)."},"description":"Delivered files, in package order."}},"required":["format","profile","tenantId","roomId","generatedAt","itemCount","totalBytes","manifestSha256","items"],"description":"Hash manifest of one hand-off package."},"receipt":{"type":"object","nullable":true,"properties":{"format":{"type":"string","enum":["ddr-handoff-receipt/1"]},"profile":{"type":"string","enum":["hdn","closing"],"description":"Recipient export profile (HDN/lender first)."},"tenantId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"recipient":{"type":"string","minLength":1,"maxLength":200,"description":"Who the package goes to."},"generatedAt":{"type":"string","format":"date-time","description":"Receipt generation time (UTC, ISO-8601)."},"itemCount":{"type":"integer","minimum":0},"totalBytes":{"type":"integer","minimum":0},"manifestSha256":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"The manifest this receipt covers."}},"required":["format","profile","tenantId","roomId","recipient","generatedAt","itemCount","totalBytes","manifestSha256"],"description":"Receipt for one hand-off package (ids, counts and hash only)."},"failureCode":{"type":"string","nullable":true,"pattern":"^[A-Z][A-Z0-9_]{0,62}$"},"sizeBytes":{"type":"integer","nullable":true,"minimum":0},"createdAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","nullable":true,"format":"date-time"},"expiresAt":{"type":"string","format":"date-time"}},"required":["id","roomId","profile","recipient","status","manifest","receipt","failureCode","sizeBytes","createdAt","completedAt","expiresAt"],"description":"One hand-off package export (ids, dates, counts and the built manifest plus receipt)."}},"truncated":{"type":"boolean"}},"required":["exports","truncated"],"description":"The caller's recent hand-off package exports, newest first."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown room, no manage right on the room root, a guest or a support session (including cross-tenant, PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/hand-off-packages/{exportId}/download":{"get":{"operationId":"downloadHandoffPackage","summary":"Download a built hand-off package (ZIP)","description":"Streams the built hand-off package ZIP (PRF-07 / TPRF-04): `manifest.json`, `receipt.json` and the delivered PDF/A-2b renditions. Requires `room.export.download` (manage on the room root, firm users only) and the caller must be the export creator in this room (else 404, PERM-02); membership, permission and step-up are re-checked on every request. Streams the decrypted package verified against its recorded hash and writes `export.downloaded` before the first byte. 409 `DOWNLOAD_NOT_READY` while queued/building or after an honest build failure, 410 `DOWNLOAD_EXPIRED` after the 7-day retention. No permanent public URL; ids, counts, codes and hashes only.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Hand-off package export id."},"required":true,"description":"Hand-off package export id.","name":"exportId","in":"path"}],"responses":{"200":{"description":"The hand-off package ZIP.","headers":{"Content-Disposition":{"schema":{"type":"string","description":"`attachment` with a sanitised package file name."},"required":true,"description":"`attachment` with a sanitised package file name."},"Cache-Control":{"schema":{"type":"string","enum":["no-store"],"description":"Never cached."},"required":true,"description":"Never cached."}},"content":{"application/zip":{"schema":{"type":"string","description":"The ZIP bytes."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"The caller may see the room but may not export it.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown room, no manage right on the room root, a guest or a support session (including cross-tenant, PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"DOWNLOAD_NOT_READY: the export is queued, building or failed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"410":{"description":"DOWNLOAD_EXPIRED: the export is past its retention window.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"AUDIT_UNAVAILABLE: the audit event could not be written; nothing was served.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/dossier-packs/preview":{"post":{"operationId":"previewDossierPack","summary":"Preview the exact effective dossier pack","description":"Requires room.create. Validates office revision, enabled pack, pinned template content; never writes or grants rights.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"packId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable pack id (lower snake case, never a label)."},"packVersion":{"type":"integer","minimum":1,"maximum":1000000,"description":"Pack version (immutable once released)."},"officeRevision":{"type":"integer","minimum":0},"language":{"type":"string","enum":["nl","en"],"default":"nl"}},"required":["packId","packVersion","officeRevision"],"additionalProperties":false}}}},"responses":{"200":{"description":"Exact effective definition and frozen template content.","content":{"application/json":{"schema":{"type":"object","properties":{"definition":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable pack id (lower snake case, never a label)."},"version":{"type":"integer","minimum":1,"maximum":1000000,"description":"Pack version (immutable once released)."},"sectorProfileId":{"anyOf":[{"type":"string","enum":["legal","mortgage","notary","accountancy","financial_planning","mediation","insolvency","real_estate","mergers_acquisitions","fundraising","public_sector","corporate","healthcare_life_sciences"],"description":"Profession profile of the firm (ADR-0058): seven legacy profiles plus six additive sector profiles. A profile only groups packs and wording; it never grants access."},{"type":"string","enum":["general"]}],"description":"Pack grouping: a profession profile id or the neutral general grouping (never a vertical)."},"lifecycle":{"type":"string","enum":["draft","available","retired"],"description":"Pack lifecycle: draft (in build), available (offered) or retired (kept readable, never offered)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"description":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"compatibleRoomType":{"type":"string","enum":["client_portal","litigation","mortgage_advice"],"description":"Legacy room type the pack builds on (no new room type)."},"modules":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","enum":["documents","requests","review","search","qa","signing","exports","messaging","deadlines","parties","retention","notifications"],"description":"Known platform module id a pack may suggest."},"enabled":{"type":"boolean","description":"Suggested default; an authorised actor can override it per office."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional NL/EN wording for the module in this pack."},"note":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional NL/EN note (for example an honest availability remark)."}},"required":["id","enabled"],"additionalProperties":false,"description":"One module suggestion of a pack (never a permission)."},"maxItems":30,"description":"Module suggestions."},"indexBlueprint":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","pattern":"^[a-z0-9-]+$","description":"Stable node key (never renamed once released)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"kind":{"type":"string","enum":["folder","placeholder"],"description":"Starter node kind."},"children":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","pattern":"^[a-z0-9-]+$"},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"kind":{"type":"string","enum":["folder","placeholder"]}},"required":["key","label","kind"],"additionalProperties":false},"maxItems":50,"description":"One level of children; deeper nesting is the wizard’s job."}},"required":["key","label","kind"],"additionalProperties":false,"description":"One starter index node of a pack."},"maxItems":50,"description":"Starter index structure; an empty array means the pack imposes no index obligations."},"templateRefs":{"type":"array","items":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"maxLength":100,"description":"Real request-template id."},"builtIn":{"type":"boolean","description":"True for a read-only built-in starter; false for a saved firm template."},"version":{"type":"number","enum":[1],"description":"Built-in definition version; only 1 is valid and only for built-in starters."},"updatedAt":{"type":"string","format":"date-time","description":"Exact `updated_at` of a saved firm template (required when builtIn is false)."},"contentHash":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"Exact content hash of a saved firm template (required when builtIn is false)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional NL/EN wording for the reference."}},"required":["templateId","builtIn"],"additionalProperties":false,"description":"Reference to a real request template at an exact, verifiable version."},"maxItems":50,"description":"Ready-made template references; an empty array means the pack requires no templates."},"metadataFields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_.]{0,62}$","description":"Metadata key of the shared dossier context (SP06)."},"required":{"type":"boolean","description":"Suggested required flag."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["key"],"additionalProperties":false,"description":"One metadata field a pack uses."},"maxItems":50,"description":"Metadata the pack uses (SP06)."},"workflowDefinitionRef":{"type":"object","nullable":true,"properties":{"code":{"type":"string","pattern":"^[A-Z][A-Z0-9_]{0,62}$","description":"Workflow definition code (never content)."},"version":{"type":"integer","minimum":1}},"required":["code"],"additionalProperties":false,"description":"Optional generic workflow reference (SP06)."},"roleSuggestions":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["firm_admin","compliance_officer","member","assistant","guest"],"description":"Existing role code."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"rationale":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["role","label"],"additionalProperties":false,"description":"Role suggestion of a pack: wording and an existing role code, never a grant."},"maxItems":20,"description":"Role suggestions (never grants)."},"sensitivityRecommendations":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["none","confidential","wwft","bsn","financial","medical","legal_privilege"],"description":"Sensitivity recommendation; the server-side policy stays authoritative."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"note":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false,"description":"One sensitivity recommendation of a pack."},"maxItems":20,"description":"Sensitivity recommendations (API policy stays lead)."},"retentionSourceRefs":{"type":"array","items":{"type":"object","properties":{"ref":{"type":"string","pattern":"^[A-Za-z0-9._:-]{1,200}$","description":"Catalogue code or ADR id (for example a retention class id)."},"note":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["ref"],"additionalProperties":false,"description":"Retention/legal source reference of a pack."},"maxItems":20,"description":"Retention/legal sources."},"availabilityNotes":{"type":"array","items":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"maxItems":20,"description":"Honest NL/EN availability remarks shown with the pack."}},"required":["id","version","sectorProfileId","lifecycle","label","description","compatibleRoomType","modules","indexBlueprint","templateRefs","metadataFields","workflowDefinitionRef","roleSuggestions","sensitivityRecommendations","retentionSourceRefs","availabilityNotes"],"additionalProperties":false,"description":"Immutable versioned definition of one dossier pack."},"officeRevision":{"type":"integer","minimum":0},"language":{"type":"string","enum":["nl","en"]},"templateSnapshots":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"maxLength":100,"description":"Real request-template id."},"builtIn":{"type":"boolean","description":"True for a read-only built-in starter; false for a saved firm template."},"version":{"type":"number","enum":[1],"description":"Built-in definition version; only 1 is valid and only for built-in starters."},"updatedAt":{"type":"string","format":"date-time","description":"Exact `updated_at` of a saved firm template (required when builtIn is false)."},"contentHash":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"Exact content hash of a saved firm template (required when builtIn is false)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional NL/EN wording for the reference."}},"required":["templateId","builtIn"],"additionalProperties":false,"description":"Reference to a real request template at an exact, verifiable version."},"contentHash":{"type":"string","pattern":"^[a-f0-9]{64}$"},"template":{"type":"object","properties":{"id":{"type":"string","maxLength":100},"name":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"description":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"profession":{"type":"string","enum":["legal","mortgage","notary","accounting","insolvency","general"],"description":"Profession a request template is made for."},"builtIn":{"type":"boolean","description":"False for a template the firm saved (editable)."},"coverInstructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Cover \"Instructies\" page of requests made from this template."},"participants":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Expected answer slot of this participant."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the participant (firm dossier vocabulary)."}},"required":["slot","label"],"description":"Expected participant of a firm template: answer slot plus display label."},"maxItems":10,"description":"Expected named slots of this template (roles only); absent on unrostered templates."},"updatedAt":{"type":"string","format":"date-time"},"contentHash":{"type":"string","pattern":"^[a-f0-9]{64}$","description":"Exact content fingerprint of a saved firm template (SP07). Required to pin a firm template reference in a versioned dossier pack; absent for read-only built-in starters, whose version is 1."},"sections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"items":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Instruction text in the safe rich-text subset (ADR-0048)."},"footnote":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"Defaults to `file`."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false},"maxItems":30}},"additionalProperties":false,"description":"Template answer rules (ADR-0048)."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named item icon of the request form (ADR-0048); the web maps it onto the icon set."},"required":{"type":"boolean"},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for; null or absent is shared."},"allowNotApplicable":{"type":"boolean","description":"Defaults to the inverse of `required`."},"allowMultiple":{"type":"boolean","description":"Defaults to true."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50},"targetPath":{"type":"string","nullable":true,"maxLength":200,"description":"Title of a top-level room folder."},"bsnAutoMask":{"type":"boolean","description":"Default of the item: burn every BSN out of a delivered file (ADR-0053)."},"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650,"description":"Default validity rule of the item in days (ADR-0053)."}},"required":["title","instructions","required","targetPath"],"description":"Template item."},"maxItems":100},"subsections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"items":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Instruction text in the safe rich-text subset (ADR-0048)."},"footnote":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"Defaults to `file`."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false},"maxItems":30}},"additionalProperties":false,"description":"Template answer rules (ADR-0048)."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named item icon of the request form (ADR-0048); the web maps it onto the icon set."},"required":{"type":"boolean"},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for; null or absent is shared."},"allowNotApplicable":{"type":"boolean","description":"Defaults to the inverse of `required`."},"allowMultiple":{"type":"boolean","description":"Defaults to true."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50},"targetPath":{"type":"string","nullable":true,"maxLength":200,"description":"Title of a top-level room folder."},"bsnAutoMask":{"type":"boolean","description":"Default of the item: burn every BSN out of a delivered file (ADR-0053)."},"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650,"description":"Default validity rule of the item in days (ADR-0053)."}},"required":["title","instructions","required","targetPath"],"description":"Template item."},"maxItems":100}},"required":["title","items"],"description":"Sub-section of a template (one level, ADR-0048)."},"maxItems":50},"repeat":{"type":"object","nullable":true,"properties":{"min":{"type":"integer","minimum":0,"maximum":10,"description":"Fewest repeats the client must add (0 = the group may be skipped)."},"max":{"type":"integer","minimum":1,"maximum":20,"description":"Most repeats the client may add."}},"required":["min","max"],"additionalProperties":false,"description":"Repeatable group (PRF-03): when present the section repeats min..max times (one block per repeat); absent or null is exactly one."}},"required":["title","items"],"description":"Section of a template, with optional sub-sections."}}},"required":["id","name","description","sections"],"description":"Request template (request-flow profile)."}},"required":["reference","contentHash","template"]}},"configHash":{"type":"string","pattern":"^[a-f0-9]{64}$"}},"required":["definition","officeRevision","language","templateSnapshots","configHash"]}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Denied by existing role/MFA/trial policy.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Missing or foreign resource.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Stale revision, unavailable pinned template/pack, or changed retry payload.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"428":{"description":"Fresh MFA or room terms required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"Required audit write unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/firm/dossier-packs":{"get":{"operationId":"getOfficeDossierPacks","summary":"Read office sector configuration","description":"Requires tenant.settings.update, including the existing fresh MFA policy.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"Current office revision and overrides.","content":{"application/json":{"schema":{"type":"object","properties":{"enabledProfileIds":{"type":"array","items":{"anyOf":[{"type":"string","enum":["legal","mortgage","notary","accountancy","financial_planning","mediation","insolvency","real_estate","mergers_acquisitions","fundraising","public_sector","corporate","healthcare_life_sciences"],"description":"Profession profile of the firm (ADR-0058): seven legacy profiles plus six additive sector profiles. A profile only groups packs and wording; it never grants access."},{"type":"string","enum":["general"]}],"description":"Pack grouping: a profession profile id or the neutral general grouping (never a vertical)."},"minItems":1,"maxItems":32},"defaultPackId":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable pack id (lower snake case, never a label)."},"packOverrides":{"type":"array","items":{"type":"object","properties":{"packId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable pack id (lower snake case, never a label)."},"packVersion":{"type":"integer","minimum":1,"maximum":1000000,"description":"Pack version (immutable once released)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"modules":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","enum":["documents","requests","review","search","qa","signing","exports","messaging","deadlines","parties","retention","notifications"],"description":"Known platform module id a pack may suggest."},"enabled":{"type":"boolean"}},"required":["id","enabled"],"additionalProperties":false},"maxItems":30},"templateRefs":{"type":"array","items":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"maxLength":100,"description":"Real request-template id."},"builtIn":{"type":"boolean","description":"True for a read-only built-in starter; false for a saved firm template."},"version":{"type":"number","enum":[1],"description":"Built-in definition version; only 1 is valid and only for built-in starters."},"updatedAt":{"type":"string","format":"date-time","description":"Exact `updated_at` of a saved firm template (required when builtIn is false)."},"contentHash":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"Exact content hash of a saved firm template (required when builtIn is false)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional NL/EN wording for the reference."}},"required":["templateId","builtIn"],"additionalProperties":false,"description":"Reference to a real request template at an exact, verifiable version."},"maxItems":50}},"required":["packId","packVersion"],"additionalProperties":false},"maxItems":100},"revision":{"type":"integer","minimum":0}},"required":["enabledProfileIds","defaultPackId","packOverrides","revision"],"additionalProperties":false}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Denied by existing role/MFA/trial policy.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Missing or foreign resource.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Stale revision, unavailable pinned template/pack, or changed retry payload.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"428":{"description":"Fresh MFA or room terms required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"Required audit write unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"put":{"operationId":"setOfficeDossierPacks","summary":"Update office sector configuration","description":"Optimistic revision update. Label/module/template overrides only; no rights, retention, arbitrary expressions or primary vertical changes. Exact firm template timestamp/hash validated before writing. Audited transaction.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"enabledProfileIds":{"type":"array","items":{"anyOf":[{"type":"string","enum":["legal","mortgage","notary","accountancy","financial_planning","mediation","insolvency","real_estate","mergers_acquisitions","fundraising","public_sector","corporate","healthcare_life_sciences"],"description":"Profession profile of the firm (ADR-0058): seven legacy profiles plus six additive sector profiles. A profile only groups packs and wording; it never grants access."},{"type":"string","enum":["general"]}],"description":"Pack grouping: a profession profile id or the neutral general grouping (never a vertical)."},"minItems":1,"maxItems":32},"defaultPackId":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable pack id (lower snake case, never a label)."},"packOverrides":{"type":"array","items":{"type":"object","properties":{"packId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable pack id (lower snake case, never a label)."},"packVersion":{"type":"integer","minimum":1,"maximum":1000000,"description":"Pack version (immutable once released)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"modules":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","enum":["documents","requests","review","search","qa","signing","exports","messaging","deadlines","parties","retention","notifications"],"description":"Known platform module id a pack may suggest."},"enabled":{"type":"boolean"}},"required":["id","enabled"],"additionalProperties":false},"maxItems":30},"templateRefs":{"type":"array","items":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"maxLength":100,"description":"Real request-template id."},"builtIn":{"type":"boolean","description":"True for a read-only built-in starter; false for a saved firm template."},"version":{"type":"number","enum":[1],"description":"Built-in definition version; only 1 is valid and only for built-in starters."},"updatedAt":{"type":"string","format":"date-time","description":"Exact `updated_at` of a saved firm template (required when builtIn is false)."},"contentHash":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"Exact content hash of a saved firm template (required when builtIn is false)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional NL/EN wording for the reference."}},"required":["templateId","builtIn"],"additionalProperties":false,"description":"Reference to a real request template at an exact, verifiable version."},"maxItems":50}},"required":["packId","packVersion"],"additionalProperties":false},"maxItems":100},"expectedRevision":{"type":"integer","minimum":0}},"required":["enabledProfileIds","defaultPackId","packOverrides","expectedRevision"],"additionalProperties":false}}}},"responses":{"200":{"description":"New office revision.","content":{"application/json":{"schema":{"type":"object","properties":{"enabledProfileIds":{"type":"array","items":{"anyOf":[{"type":"string","enum":["legal","mortgage","notary","accountancy","financial_planning","mediation","insolvency","real_estate","mergers_acquisitions","fundraising","public_sector","corporate","healthcare_life_sciences"],"description":"Profession profile of the firm (ADR-0058): seven legacy profiles plus six additive sector profiles. A profile only groups packs and wording; it never grants access."},{"type":"string","enum":["general"]}],"description":"Pack grouping: a profession profile id or the neutral general grouping (never a vertical)."},"minItems":1,"maxItems":32},"defaultPackId":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable pack id (lower snake case, never a label)."},"packOverrides":{"type":"array","items":{"type":"object","properties":{"packId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable pack id (lower snake case, never a label)."},"packVersion":{"type":"integer","minimum":1,"maximum":1000000,"description":"Pack version (immutable once released)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"modules":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","enum":["documents","requests","review","search","qa","signing","exports","messaging","deadlines","parties","retention","notifications"],"description":"Known platform module id a pack may suggest."},"enabled":{"type":"boolean"}},"required":["id","enabled"],"additionalProperties":false},"maxItems":30},"templateRefs":{"type":"array","items":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"maxLength":100,"description":"Real request-template id."},"builtIn":{"type":"boolean","description":"True for a read-only built-in starter; false for a saved firm template."},"version":{"type":"number","enum":[1],"description":"Built-in definition version; only 1 is valid and only for built-in starters."},"updatedAt":{"type":"string","format":"date-time","description":"Exact `updated_at` of a saved firm template (required when builtIn is false)."},"contentHash":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"Exact content hash of a saved firm template (required when builtIn is false)."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional NL/EN wording for the reference."}},"required":["templateId","builtIn"],"additionalProperties":false,"description":"Reference to a real request template at an exact, verifiable version."},"maxItems":50}},"required":["packId","packVersion"],"additionalProperties":false},"maxItems":100},"revision":{"type":"integer","minimum":0}},"required":["enabledProfileIds","defaultPackId","packOverrides","revision"],"additionalProperties":false}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Denied by existing role/MFA/trial policy.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Missing or foreign resource.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Stale revision, unavailable pinned template/pack, or changed retry payload.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"428":{"description":"Fresh MFA or room terms required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"Required audit write unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/from-pack":{"post":{"operationId":"createRoomFromPack","summary":"Create a dataroom with a versioned dossier pack","description":"One transaction for existing open matter, room, creator membership, folders/placeholders, optional existing mortgage adapter, frozen template contents and audit. Never creates client answers or sends invitations. Retry keys scoped to office+actor: identical retry returns same room after fresh authorization; changed payload is 409.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"packId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable pack id (lower snake case, never a label)."},"packVersion":{"type":"integer","minimum":1,"maximum":1000000,"description":"Pack version (immutable once released)."},"officeRevision":{"type":"integer","minimum":0},"language":{"type":"string","enum":["nl","en"],"default":"nl"},"matterId":{"type":"string","nullable":true,"format":"uuid","description":"Same-tenant matter, or null for a standalone dataroom."},"name":{"type":"string","minLength":1,"maxLength":200,"description":"Room name."},"idempotencyKey":{"type":"string","pattern":"^[A-Za-z0-9._:-]{1,128}$"},"mortgageFile":{"type":"object","properties":{"reference":{"type":"string","nullable":true,"minLength":1,"maxLength":40},"applicantNames":{"type":"array","items":{"type":"string","minLength":1,"maxLength":120},"minItems":1,"maxItems":2},"purpose":{"type":"string","enum":["purchase","refinance","move","divorce","construction"],"description":"Purpose of the mortgage: purchase, refinance, move, divorce or construction."},"loanAmountCents":{"type":"integer","nullable":true,"minimum":0,"maximum":1000000000000},"stage":{"type":"string","enum":["orientation","fact_finding","advice","application","offer","notary","aftercare"],"description":"Stage of the mortgage file."},"financingConditionDate":{"type":"string","nullable":true,"format":"date"},"bindingOfferDate":{"type":"string","nullable":true,"format":"date"},"notaryDate":{"type":"string","nullable":true,"format":"date"},"expectedRevision":{"type":"integer","minimum":1,"description":"Optimistic concurrency: the revision the caller read (409 on mismatch)."}},"required":["reference","applicantNames","purpose","loanAmountCents","stage","financingConditionDate","bindingOfferDate","notaryDate"],"additionalProperties":false,"description":"Create or replace the mortgage file of a room."}},"required":["packId","packVersion","officeRevision","matterId","name","idempotencyKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"Authorized identical retry.","content":{"application/json":{"schema":{"type":"object","properties":{"room":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Room id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"matterId":{"type":"string","nullable":true,"format":"uuid","description":"Owning matter."},"name":{"type":"string","nullable":true,"description":"Room name."},"type":{"type":"string","description":"Room type."},"state":{"type":"string","enum":["active","frozen","closed","archived"],"description":"Room states visible through this API (destroying/destroyed are never listed)."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."},"metrics":{"type":"object","properties":{"documentCount":{"type":"integer","minimum":0,"description":"Documents in the room (trash excluded)."},"memberCount":{"type":"integer","minimum":0,"description":"Distinct principals with a membership in the room (ADR-0005 §4)."},"openRequestCount":{"type":"integer","minimum":0,"description":"Upload sessions still open in the room (DOC-14 open requests)."},"storageUsedBytes":{"type":"integer","minimum":0,"description":"Original file bytes for clean, not-yet-destroyed room blobs, all versions included; encryption overhead excluded."},"storageQuotaBytes":{"type":"integer","nullable":true,"minimum":0,"description":"Effective shared office storage allowance in bytes; null when unavailable."}},"required":["documentCount","memberCount","openRequestCount","storageUsedBytes","storageQuotaBytes"],"description":"Dataroom metrics (UX-04); omitted when unknown."},"edition":{"type":"string","enum":["general","transaction","legal","finance","corporate"],"description":"Room edition (DRE-3); omitted by older servers."}},"required":["id","tenantId","matterId","name","type","state","createdAt"],"description":"A data room."},"snapshot":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid"},"createdBy":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"revision":{"type":"integer","minimum":0,"exclusiveMinimum":true},"packId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable pack id (lower snake case, never a label)."},"packVersion":{"type":"string"},"officeRevision":{"type":"integer","minimum":0},"configVersion":{"type":"number","enum":[1]},"configHash":{"type":"string","pattern":"^[a-f0-9]{64}$"},"effectiveConfig":{"type":"object","additionalProperties":{"nullable":true}},"createdAt":{"type":"string","format":"date-time"}},"required":["tenantId","createdBy","roomId","revision","packId","packVersion","officeRevision","configVersion","configHash","effectiveConfig","createdAt"]},"replayed":{"type":"boolean"}},"required":["room","snapshot","replayed"]}}}},"201":{"description":"Created room and immutable snapshot.","content":{"application/json":{"schema":{"type":"object","properties":{"room":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Room id."},"tenantId":{"type":"string","format":"uuid","description":"Owning tenant."},"matterId":{"type":"string","nullable":true,"format":"uuid","description":"Owning matter."},"name":{"type":"string","nullable":true,"description":"Room name."},"type":{"type":"string","description":"Room type."},"state":{"type":"string","enum":["active","frozen","closed","archived"],"description":"Room states visible through this API (destroying/destroyed are never listed)."},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp."},"metrics":{"type":"object","properties":{"documentCount":{"type":"integer","minimum":0,"description":"Documents in the room (trash excluded)."},"memberCount":{"type":"integer","minimum":0,"description":"Distinct principals with a membership in the room (ADR-0005 §4)."},"openRequestCount":{"type":"integer","minimum":0,"description":"Upload sessions still open in the room (DOC-14 open requests)."},"storageUsedBytes":{"type":"integer","minimum":0,"description":"Original file bytes for clean, not-yet-destroyed room blobs, all versions included; encryption overhead excluded."},"storageQuotaBytes":{"type":"integer","nullable":true,"minimum":0,"description":"Effective shared office storage allowance in bytes; null when unavailable."}},"required":["documentCount","memberCount","openRequestCount","storageUsedBytes","storageQuotaBytes"],"description":"Dataroom metrics (UX-04); omitted when unknown."},"edition":{"type":"string","enum":["general","transaction","legal","finance","corporate"],"description":"Room edition (DRE-3); omitted by older servers."}},"required":["id","tenantId","matterId","name","type","state","createdAt"],"description":"A data room."},"snapshot":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid"},"createdBy":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"revision":{"type":"integer","minimum":0,"exclusiveMinimum":true},"packId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable pack id (lower snake case, never a label)."},"packVersion":{"type":"string"},"officeRevision":{"type":"integer","minimum":0},"configVersion":{"type":"number","enum":[1]},"configHash":{"type":"string","pattern":"^[a-f0-9]{64}$"},"effectiveConfig":{"type":"object","additionalProperties":{"nullable":true}},"createdAt":{"type":"string","format":"date-time"}},"required":["tenantId","createdBy","roomId","revision","packId","packVersion","officeRevision","configVersion","configHash","effectiveConfig","createdAt"]},"replayed":{"type":"boolean"}},"required":["room","snapshot","replayed"]}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Denied by existing role/MFA/trial policy.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Missing or foreign resource.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Stale revision, unavailable pinned template/pack, or changed retry payload.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"428":{"description":"Fresh MFA or room terms required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"Required audit write unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/pack":{"get":{"operationId":"getRoomDossierPack","summary":"Read the room-bound pack configuration","description":"Existing room.read membership/terms gates; firm users only. Legacy rooms have null snapshot. Audited before response.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"Immutable snapshot or null.","content":{"application/json":{"schema":{"type":"object","properties":{"snapshot":{"type":"object","nullable":true,"properties":{"tenantId":{"type":"string","format":"uuid"},"createdBy":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"revision":{"type":"integer","minimum":0,"exclusiveMinimum":true},"packId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable pack id (lower snake case, never a label)."},"packVersion":{"type":"string"},"officeRevision":{"type":"integer","minimum":0},"configVersion":{"type":"number","enum":[1]},"configHash":{"type":"string","pattern":"^[a-f0-9]{64}$"},"effectiveConfig":{"type":"object","additionalProperties":{"nullable":true}},"createdAt":{"type":"string","format":"date-time"}},"required":["tenantId","createdBy","roomId","revision","packId","packVersion","officeRevision","configVersion","configHash","effectiveConfig","createdAt"]}},"required":["snapshot"]}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Denied by existing role/MFA/trial policy.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Missing or foreign resource.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Stale revision, unavailable pinned template/pack, or changed retry payload.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"428":{"description":"Fresh MFA or room terms required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"Required audit write unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/pack/templates":{"get":{"operationId":"getRoomPackTemplates","summary":"Read request templates for this room","description":"Existing room.read and flow_template.read gates. Frozen room templates precede current office/built-in templates; subsequent edit/archive never silently replaces the frozen content. Audited before response.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"Room-bound and current request templates.","content":{"application/json":{"schema":{"type":"object","properties":{"templates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","maxLength":100},"name":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"description":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"profession":{"type":"string","enum":["legal","mortgage","notary","accounting","insolvency","general"],"description":"Profession a request template is made for."},"builtIn":{"type":"boolean","description":"False for a template the firm saved (editable)."},"coverInstructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Cover \"Instructies\" page of requests made from this template."},"participants":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Expected answer slot of this participant."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the participant (firm dossier vocabulary)."}},"required":["slot","label"],"description":"Expected participant of a firm template: answer slot plus display label."},"maxItems":10,"description":"Expected named slots of this template (roles only); absent on unrostered templates."},"updatedAt":{"type":"string","format":"date-time"},"contentHash":{"type":"string","pattern":"^[a-f0-9]{64}$","description":"Exact content fingerprint of a saved firm template (SP07). Required to pin a firm template reference in a versioned dossier pack; absent for read-only built-in starters, whose version is 1."},"sections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"items":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Instruction text in the safe rich-text subset (ADR-0048)."},"footnote":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"Defaults to `file`."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false},"maxItems":30}},"additionalProperties":false,"description":"Template answer rules (ADR-0048)."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named item icon of the request form (ADR-0048); the web maps it onto the icon set."},"required":{"type":"boolean"},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for; null or absent is shared."},"allowNotApplicable":{"type":"boolean","description":"Defaults to the inverse of `required`."},"allowMultiple":{"type":"boolean","description":"Defaults to true."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50},"targetPath":{"type":"string","nullable":true,"maxLength":200,"description":"Title of a top-level room folder."},"bsnAutoMask":{"type":"boolean","description":"Default of the item: burn every BSN out of a delivered file (ADR-0053)."},"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650,"description":"Default validity rule of the item in days (ADR-0053)."}},"required":["title","instructions","required","targetPath"],"description":"Template item."},"maxItems":100},"subsections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"items":{"type":"array","items":{"type":"object","properties":{"title":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"instructions":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Instruction text in the safe rich-text subset (ADR-0048)."},"footnote":{"type":"object","nullable":true,"properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."},"answerKind":{"type":"string","enum":["file","short_text","long_text","number","amount","date","yes_no","choice"],"description":"Defaults to `file`."},"key":{"type":"string","nullable":true,"pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"showWhen":{"type":"object","nullable":true,"properties":{"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,39}$","description":"Item key: a stable reference inside the request (conditions refer to it)."},"values":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"minItems":1,"maxItems":30}},"required":["key","values"],"additionalProperties":false,"description":"Condition: show when the answer of item `key` is one of `values`."},"answerRules":{"type":"object","nullable":true,"properties":{"maxLength":{"type":"integer","minimum":1,"maximum":10000,"description":"Text: maximum length."},"min":{"type":"number","nullable":true,"description":"Number / amount: inclusive minimum."},"max":{"type":"number","nullable":true,"description":"Number / amount: inclusive maximum."},"minDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: earliest acceptable ISO date (M2 F04 author bounds)."},"maxDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Date: latest acceptable ISO date (M2 F04 author bounds)."},"multiple":{"type":"boolean","description":"Choice: more than one option allowed."},"options":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{0,39}$"},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"NL/EN text of a template (labels, titles, help text, statements)."}},"required":["code","label"],"additionalProperties":false},"maxItems":30}},"additionalProperties":false,"description":"Template answer rules (ADR-0048)."},"icon":{"type":"string","nullable":true,"enum":["document","identity","passport","bank","savings","investments","pension","tax","insurance","employer","payslip","home","valuation","contract","debt","gift","study","court","correspondence","invoice","company","family","medical","vehicle","photo","signature","calendar","email","spreadsheet","archive","other",null],"description":"Named item icon of the request form (ADR-0048); the web maps it onto the icon set."},"required":{"type":"boolean"},"assignee":{"type":"string","nullable":true,"pattern":"^applicant_[1-9][0-9]?$","description":"Participant slot this question is for; null or absent is shared."},"allowNotApplicable":{"type":"boolean","description":"Defaults to the inverse of `required`."},"allowMultiple":{"type":"boolean","description":"Defaults to true."},"acceptedKinds":{"type":"array","items":{"type":"string","enum":["any","pdf","image","office","email"],"description":"Accepted file kind of an item (ADR-0048)."},"maxItems":5},"expectedCount":{"type":"integer","nullable":true,"minimum":1,"maximum":50},"targetPath":{"type":"string","nullable":true,"maxLength":200,"description":"Title of a top-level room folder."},"bsnAutoMask":{"type":"boolean","description":"Default of the item: burn every BSN out of a delivered file (ADR-0053)."},"validForDays":{"type":"integer","nullable":true,"minimum":1,"maximum":3650,"description":"Default validity rule of the item in days (ADR-0053)."}},"required":["title","instructions","required","targetPath"],"description":"Template item."},"maxItems":100}},"required":["title","items"],"description":"Sub-section of a template (one level, ADR-0048)."},"maxItems":50},"repeat":{"type":"object","nullable":true,"properties":{"min":{"type":"integer","minimum":0,"maximum":10,"description":"Fewest repeats the client must add (0 = the group may be skipped)."},"max":{"type":"integer","minimum":1,"maximum":20,"description":"Most repeats the client may add."}},"required":["min","max"],"additionalProperties":false,"description":"Repeatable group (PRF-03): when present the section repeats min..max times (one block per repeat); absent or null is exactly one."}},"required":["title","items"],"description":"Section of a template, with optional sub-sections."}}},"required":["id","name","description","sections"],"description":"Request template (request-flow profile)."}}},"required":["templates"],"description":"Request templates (request-flow profile)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Denied by existing role/MFA/trial policy.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Missing or foreign resource.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Stale revision, unavailable pinned template/pack, or changed retry payload.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"428":{"description":"Fresh MFA or room terms required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"Required audit write unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/workstage":{"get":{"operationId":"getRoomWorkstage","summary":"Read the shared dossier workstage of a room","description":"Existing flow.read room policy; firm members only, guests read their portal item instead. Returns the stored workstage with allowed next stages plus read-only echoes of the room lifecycle and the authoritative mortgage pipeline (never mutated here). Audited before response.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"Current workstage, allowed transitions and read-only echoes.","content":{"application/json":{"schema":{"type":"object","properties":{"workstage":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"stage":{"type":"string","enum":["intake","in_progress","waiting_client","review","completed","cancelled"],"description":"Operational workstage of a dossier room (SP06, separate from room lifecycle)."},"revision":{"type":"integer","minimum":0},"ownerPrincipalId":{"type":"string","nullable":true,"format":"uuid"},"dueOn":{"type":"string","nullable":true,"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"context":{"type":"object","additionalProperties":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9._:@+/-]{0,127}$","description":"Shared context value (short code, id or ISO date; never free text)."}},"updatedBy":{"type":"string"},"updatedAt":{"type":"string"},"allowedTransitions":{"type":"array","items":{"type":"string","enum":["intake","in_progress","waiting_client","review","completed","cancelled"],"description":"Operational workstage of a dossier room (SP06, separate from room lifecycle)."}},"mortgageStage":{"type":"string","nullable":true,"enum":["orientation","fact_finding","advice","application","offer","notary","aftercare",null],"description":"Stage of the mortgage file."},"roomState":{"type":"string"}},"required":["tenantId","roomId","stage","revision","ownerPrincipalId","dueOn","context","updatedBy","updatedAt","allowedTransitions","mortgageStage","roomState"],"description":"Room workstage with next actions and read-only mortgage/lifecycle echoes."}},"required":["workstage"],"description":"Room workstage read/advance response (SP06)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Denied by existing role/MFA/trial policy.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Missing or foreign resource.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Stale revision, unavailable pinned template/pack, or changed retry payload.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"428":{"description":"Fresh MFA or room terms required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"Required audit write unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"post":{"operationId":"advanceRoomWorkstage","summary":"Advance the shared dossier workstage of a room","description":"Existing flow.create room policy (manage, users only, mutating): the caller must already hold the room write grant and pass the expected revision. Guards unknown rooms, closed/frozen rooms, stale revisions and disallowed transitions; writes the workstage and its audit atomically. Mortgage pipeline and room lifecycle are never changed here.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"expectedRevision":{"type":"integer","minimum":0,"maximum":1000000000,"description":"Expected workstage revision."},"to":{"type":"string","enum":["intake","in_progress","waiting_client","review","completed","cancelled"],"description":"Requested next workstage."},"ownerPrincipalId":{"type":"string","nullable":true,"format":"uuid","description":"Responsible principal, or null to clear."},"dueOn":{"type":"string","nullable":true,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Optional dossier deadline (calendar date)."},"context":{"type":"object","additionalProperties":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9._:@+/-]{0,127}$","description":"Shared context value (short code, id or ISO date; never free text)."},"description":"Minimal per-pack context codes/ids (never client content)."},"exceptionReason":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Explicit reason code for a completion-gate override (WF02, only with to completed)."}},"required":["expectedRevision","to"],"additionalProperties":false,"description":"Advance one room workstage (SP06)."}}}},"responses":{"200":{"description":"Advanced workstage with new allowed transitions.","content":{"application/json":{"schema":{"type":"object","properties":{"workstage":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"stage":{"type":"string","enum":["intake","in_progress","waiting_client","review","completed","cancelled"],"description":"Operational workstage of a dossier room (SP06, separate from room lifecycle)."},"revision":{"type":"integer","minimum":0},"ownerPrincipalId":{"type":"string","nullable":true,"format":"uuid"},"dueOn":{"type":"string","nullable":true,"pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"context":{"type":"object","additionalProperties":{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9._:@+/-]{0,127}$","description":"Shared context value (short code, id or ISO date; never free text)."}},"updatedBy":{"type":"string"},"updatedAt":{"type":"string"},"allowedTransitions":{"type":"array","items":{"type":"string","enum":["intake","in_progress","waiting_client","review","completed","cancelled"],"description":"Operational workstage of a dossier room (SP06, separate from room lifecycle)."}},"mortgageStage":{"type":"string","nullable":true,"enum":["orientation","fact_finding","advice","application","offer","notary","aftercare",null],"description":"Stage of the mortgage file."},"roomState":{"type":"string"}},"required":["tenantId","roomId","stage","revision","ownerPrincipalId","dueOn","context","updatedBy","updatedAt","allowedTransitions","mortgageStage","roomState"],"description":"Room workstage with next actions and read-only mortgage/lifecycle echoes."}},"required":["workstage"],"description":"Room workstage read/advance response (SP06)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Denied by existing role/MFA/trial policy.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Missing or foreign resource.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Stale revision, unavailable pinned template/pack, or changed retry payload.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"428":{"description":"Fresh MFA or room terms required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"Required audit write unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/pack/upgrade-preview":{"post":{"operationId":"previewRoomPackUpgrade","summary":"Preview the additive version upgrade of a room dossier pack","description":"Existing room.settings.read policy (manage, users only, read-only). Diffs the room’s current effective pack definition against the exact target version: added index/template/module suggestions, retained items and office overrides, unavailable template refs and overrides pinned to another version. Nothing is written.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"targetPackVersion":{"type":"integer","minimum":1,"maximum":1000000,"description":"Pack version (immutable once released)."},"sourceRevision":{"type":"integer","minimum":0,"exclusiveMinimum":true},"language":{"type":"string","enum":["nl","en"],"default":"nl"}},"required":["targetPackVersion","sourceRevision"],"additionalProperties":false}}}},"responses":{"200":{"description":"Additive diff, retained items and unavailable/conflicting refs.","content":{"application/json":{"schema":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid"},"packId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable pack id (lower snake case, never a label)."},"fromVersion":{"type":"integer","minimum":1,"maximum":1000000,"description":"Pack version (immutable once released)."},"toVersion":{"type":"integer","minimum":1,"maximum":1000000,"description":"Pack version (immutable once released)."},"sourceRevision":{"type":"integer","minimum":0,"exclusiveMinimum":true},"officeRevision":{"type":"integer","minimum":0},"changes":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["index","template","module","label"]},"action":{"type":"string","enum":["added","retained","unavailable","conflict"]},"ref":{"type":"string","minLength":1,"maxLength":200,"description":"Kind-qualified stable reference, never content."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional NL/EN wording of the suggestion."}},"required":["kind","action","ref"],"additionalProperties":false,"description":"One additive upgrade suggestion or a retained/unavailable/conflicting reference."}},"retained":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["index","template","module","label"]},"action":{"type":"string","enum":["added","retained","unavailable","conflict"]},"ref":{"type":"string","minLength":1,"maxLength":200,"description":"Kind-qualified stable reference, never content."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional NL/EN wording of the suggestion."}},"required":["kind","action","ref"],"additionalProperties":false,"description":"One additive upgrade suggestion or a retained/unavailable/conflicting reference."}},"unavailableRefs":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["index","template","module","label"]},"action":{"type":"string","enum":["added","retained","unavailable","conflict"]},"ref":{"type":"string","minLength":1,"maxLength":200,"description":"Kind-qualified stable reference, never content."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional NL/EN wording of the suggestion."}},"required":["kind","action","ref"],"additionalProperties":false,"description":"One additive upgrade suggestion or a retained/unavailable/conflicting reference."}},"conflicts":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["index","template","module","label"]},"action":{"type":"string","enum":["added","retained","unavailable","conflict"]},"ref":{"type":"string","minLength":1,"maxLength":200,"description":"Kind-qualified stable reference, never content."},"label":{"type":"object","properties":{"nl":{"type":"string","minLength":1,"maxLength":2000,"description":"Dutch text."},"en":{"type":"string","minLength":1,"maxLength":2000,"description":"English text."}},"required":["nl","en"],"additionalProperties":false,"description":"Optional NL/EN wording of the suggestion."}},"required":["kind","action","ref"],"additionalProperties":false,"description":"One additive upgrade suggestion or a retained/unavailable/conflicting reference."}}},"required":["roomId","packId","fromVersion","toVersion","sourceRevision","officeRevision","changes","retained","unavailableRefs","conflicts"],"description":"Additive upgrade diff: added suggestions, retained items and unavailable/conflicting refs."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Denied by existing role/MFA/trial policy.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Missing or foreign resource.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Stale revision, unavailable pinned template/pack, or changed retry payload.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"428":{"description":"Fresh MFA or room terms required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"Required audit write unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/pack/upgrade":{"post":{"operationId":"applyRoomPackUpgrade","summary":"Apply an explicit additive room dossier pack upgrade","description":"Existing room.settings.update policy (manage, users only, mutating). Merges only the chosen added refs onto the current definition and appends one immutable snapshot revision with provenance; sent requests/answers, document paths, review, retention and prior revisions are never rewritten. Stale revision, foreign refs and a changed retry payload are refused; audited with room.settings_changed.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"targetPackVersion":{"type":"integer","minimum":1,"maximum":1000000,"description":"Pack version (immutable once released)."},"sourceRevision":{"type":"integer","minimum":0,"exclusiveMinimum":true},"language":{"type":"string","enum":["nl","en"],"default":"nl"},"acceptedRefs":{"type":"array","items":{"type":"string","minLength":1,"maxLength":200},"maxItems":200,"description":"Added refs the actor chose; must be a subset of the preview additions."},"idempotencyKey":{"type":"string","pattern":"^[A-Za-z0-9._:-]{1,128}$"}},"required":["targetPackVersion","sourceRevision","acceptedRefs","idempotencyKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"Authorized identical retry.","content":{"application/json":{"schema":{"type":"object","properties":{"snapshot":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid"},"createdBy":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"revision":{"type":"integer","minimum":0,"exclusiveMinimum":true},"packId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable pack id (lower snake case, never a label)."},"packVersion":{"type":"string"},"officeRevision":{"type":"integer","minimum":0},"configVersion":{"type":"number","enum":[1]},"configHash":{"type":"string","pattern":"^[a-f0-9]{64}$"},"effectiveConfig":{"type":"object","additionalProperties":{"nullable":true}},"createdAt":{"type":"string","format":"date-time"}},"required":["tenantId","createdBy","roomId","revision","packId","packVersion","officeRevision","configVersion","configHash","effectiveConfig","createdAt"]},"appliedRefs":{"type":"array","items":{"type":"string"}},"replayed":{"type":"boolean"}},"required":["snapshot","appliedRefs","replayed"],"description":"The new append-only room pack revision and the additive refs that were applied."}}}},"201":{"description":"New append-only snapshot revision with the applied refs.","content":{"application/json":{"schema":{"type":"object","properties":{"snapshot":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid"},"createdBy":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"revision":{"type":"integer","minimum":0,"exclusiveMinimum":true},"packId":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,62}$","description":"Stable pack id (lower snake case, never a label)."},"packVersion":{"type":"string"},"officeRevision":{"type":"integer","minimum":0},"configVersion":{"type":"number","enum":[1]},"configHash":{"type":"string","pattern":"^[a-f0-9]{64}$"},"effectiveConfig":{"type":"object","additionalProperties":{"nullable":true}},"createdAt":{"type":"string","format":"date-time"}},"required":["tenantId","createdBy","roomId","revision","packId","packVersion","officeRevision","configVersion","configHash","effectiveConfig","createdAt"]},"appliedRefs":{"type":"array","items":{"type":"string"}},"replayed":{"type":"boolean"}},"required":["snapshot","appliedRefs","replayed"],"description":"The new append-only room pack revision and the additive refs that were applied."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Denied by existing role/MFA/trial policy.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Missing or foreign resource.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Stale revision, unavailable pinned template/pack, or changed retry payload.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"428":{"description":"Fresh MFA or room terms required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"Required audit write unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/deal-workflow":{"get":{"operationId":"readDealWorkflow","summary":"Read the deal phase and authorized document/group choices","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","maxLength":160},"required":false,"name":"search","in":"query"}],"responses":{"200":{"description":"Current server result; closing queues the existing export worker without sending external mail.","content":{"application/json":{"schema":{"type":"object","properties":{"truncated":{"type":"boolean"},"revision":{"type":"integer","minimum":0},"phase":{"type":"string","enum":["preparation","due_diligence","negotiation","closing"]},"documents":{"type":"array","items":{"type":"object","properties":{"nodeId":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"versionId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":0,"exclusiveMinimum":true},"title":{"type":"string"}},"required":["nodeId","documentId","versionId","versionNo","title"],"additionalProperties":false}},"groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"expiresAt":{"type":"string","nullable":true,"format":"date-time"},"memberCount":{"type":"integer","minimum":0}},"required":["id","name","expiresAt","memberCount"],"additionalProperties":false}},"recent":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["release","closing"]},"phase":{"type":"string","enum":["preparation","due_diligence","negotiation","closing"]},"revision":{"type":"integer","minimum":0},"read":{"type":"string","enum":["view","download"]},"expiresAt":{"type":"string","format":"date-time"},"documents":{"type":"array","items":{"type":"object","properties":{"nodeId":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"versionId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":0,"exclusiveMinimum":true},"title":{"type":"string"}},"required":["nodeId","documentId","versionId","versionNo","title"],"additionalProperties":false}},"groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"expiresAt":{"type":"string","nullable":true,"format":"date-time"},"memberCount":{"type":"integer","minimum":0}},"required":["id","name","expiresAt","memberCount"],"additionalProperties":false}},"appliedAt":{"type":"string","nullable":true,"format":"date-time"},"exportId":{"type":"string","nullable":true,"format":"uuid"}},"required":["id","kind","phase","revision","read","expiresAt","documents","groups","appliedAt","exportId"],"additionalProperties":false},"maxItems":20}},"required":["truncated","revision","phase","documents","groups","recent"],"additionalProperties":false}}}},"400":{"description":"Invalid selection.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Sign-in or step-up required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Refused by current policy.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unavailable or hidden room.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Stale preview, changed rights/versions, expiry, or invalid phase.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Export queue allowance exceeded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/deal-workflow/previews":{"post":{"operationId":"previewDealRelease","summary":"Preview exact document versions and recipient groups; changes no access","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid"},"expectedRevision":{"type":"integer","minimum":0},"kind":{"type":"string","enum":["release","closing"]},"phase":{"type":"string","enum":["preparation","due_diligence","negotiation","closing"]},"read":{"type":"string","enum":["view","download"]},"nodeIds":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"maxItems":200},"groupIds":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"maxItems":20}},"required":["requestId","expectedRevision","kind","phase","read","nodeIds","groupIds"],"additionalProperties":false}}}},"responses":{"200":{"description":"Current server result; closing queues the existing export worker without sending external mail.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["release","closing"]},"phase":{"type":"string","enum":["preparation","due_diligence","negotiation","closing"]},"revision":{"type":"integer","minimum":0},"read":{"type":"string","enum":["view","download"]},"expiresAt":{"type":"string","format":"date-time"},"documents":{"type":"array","items":{"type":"object","properties":{"nodeId":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"versionId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":0,"exclusiveMinimum":true},"title":{"type":"string"}},"required":["nodeId","documentId","versionId","versionNo","title"],"additionalProperties":false}},"groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"expiresAt":{"type":"string","nullable":true,"format":"date-time"},"memberCount":{"type":"integer","minimum":0}},"required":["id","name","expiresAt","memberCount"],"additionalProperties":false}},"appliedAt":{"type":"string","nullable":true,"format":"date-time"},"exportId":{"type":"string","nullable":true,"format":"uuid"}},"required":["id","kind","phase","revision","read","expiresAt","documents","groups","appliedAt","exportId"],"additionalProperties":false}}}},"400":{"description":"Invalid selection.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Sign-in or step-up required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Refused by current policy.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unavailable or hidden room.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Stale preview, changed rights/versions, expiry, or invalid phase.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Export queue allowance exceeded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/deal-workflow/previews/{previewId}/apply":{"post":{"operationId":"applyDealRelease","summary":"Explicitly apply a fresh permission preview or freeze a closing selection exactly once","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"previewId","in":"path"}],"responses":{"200":{"description":"Current server result; closing queues the existing export worker without sending external mail.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"kind":{"type":"string","enum":["release","closing"]},"phase":{"type":"string","enum":["preparation","due_diligence","negotiation","closing"]},"revision":{"type":"integer","minimum":0},"read":{"type":"string","enum":["view","download"]},"expiresAt":{"type":"string","format":"date-time"},"documents":{"type":"array","items":{"type":"object","properties":{"nodeId":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"versionId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":0,"exclusiveMinimum":true},"title":{"type":"string"}},"required":["nodeId","documentId","versionId","versionNo","title"],"additionalProperties":false}},"groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"expiresAt":{"type":"string","nullable":true,"format":"date-time"},"memberCount":{"type":"integer","minimum":0}},"required":["id","name","expiresAt","memberCount"],"additionalProperties":false}},"appliedAt":{"type":"string","nullable":true,"format":"date-time"},"exportId":{"type":"string","nullable":true,"format":"uuid"}},"required":["id","kind","phase","revision","read","expiresAt","documents","groups","appliedAt","exportId"],"additionalProperties":false}}}},"400":{"description":"Invalid selection.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Sign-in or step-up required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Refused by current policy.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unavailable or hidden room.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Stale preview, changed rights/versions, expiry, or invalid phase.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Export queue allowance exceeded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/flows/{flowId}/items/{itemId}/share":{"post":{"operationId":"shareFlowItem","summary":"Share one private item with every bound party","description":"Explicit private-to-joint item share (WF05): the mediator shares one item of an individual (non-joint) party flow with every bound party. Only that version becomes joint; the private drafts and history stay untouched. Requires flow_item.review on the item node; a guest gets 404. The response previews the recipients (slot and display label only, never names or answers).","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","minLength":1,"maxLength":280,"description":"Why this item becomes joint (dossier vocabulary, at most 280 characters)."}},"required":["reason"],"additionalProperties":false,"description":"Explicit share action on one request item (WF05)."}}}},"responses":{"200":{"description":"Shared item with its recipient preview.","content":{"application/json":{"schema":{"type":"object","properties":{"flowId":{"type":"string","format":"uuid"},"itemId":{"type":"string","format":"uuid"},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of one request item (WF05): slot-private or explicitly shared joint."},"sharedBy":{"type":"string","format":"uuid"},"sharedAt":{"type":"string","format":"date-time"},"jointVisibleTo":{"type":"array","items":{"type":"object","properties":{"slot":{"type":"string","pattern":"^applicant_[1-9][0-9]?$","description":"Applicant slot of an answer: applicant_<n> (two applicants answer separately)."},"label":{"type":"string","minLength":1,"maxLength":200,"description":"Display label of the party (dossier vocabulary)."}},"required":["slot","label"],"additionalProperties":false},"description":"Parties that can now read the item (recipient preview, slot and label only)."}},"required":["flowId","itemId","visibility","sharedBy","sharedAt","jointVisibleTo"],"description":"Explicitly shared request item with its recipient preview (WF05)."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: no review permission on the item.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, flow or item (PERM-02 hides existence).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"CONFLICT: the flow is not active (policy refusals answer 400).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"delete":{"operationId":"withdrawFlowItemShare","summary":"Withdraw the share of one joint item","description":"Withdraw an explicit item share (WF05): the item becomes slot-private again while the private drafts and history stay untouched. Existing room rights are unchanged. Requires flow_item.review on the item node; a guest gets 404.","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"flowId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"itemId","in":"path"}],"responses":{"200":{"description":"Withdrawn item share: the item is slot-private again.","content":{"application/json":{"schema":{"type":"object","properties":{"flowId":{"type":"string","format":"uuid"},"itemId":{"type":"string","format":"uuid"},"visibility":{"type":"string","enum":["private","joint"],"description":"Portal visibility of one request item (WF05): slot-private or explicitly shared joint."}},"required":["flowId","itemId","visibility"],"description":"Withdrawn item share: the item is slot-private again (WF05)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: no review permission on the item.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, flow or item (PERM-02 hides existence).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"CONFLICT: the flow is not active (policy refusals answer 400).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/claims":{"get":{"operationId":"listRoomClaims","summary":"Bounded internal register of a room's creditor claims","description":"The trustee-facing bounded register of one room's insolvency creditor claims (WF04): one row per sent creditor request with the guest-safe status, the informational delivered-evidence count, dates and a duplicate signal when another claim in the room shares the same normalised reference. Search (`query`) matches the creditor's own reference but the reference value is never echoed and the amount is never returned, so no other creditor's names, totals, ids, amounts or evidence are reachable. Firm-only (`flow.read` on the room; a guest gets 404).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"roomId","in":"query"},{"schema":{"type":"string","maxLength":200,"description":"Case-insensitive match on the creditor claim reference (never echoed back)."},"required":false,"description":"Case-insensitive match on the creditor claim reference (never echoed back).","name":"query","in":"query"},{"schema":{"type":"string","enum":["not_submitted","received","correction_requested","under_review"],"description":"Guest-safe creditor claim status (WF04); never an internal acceptance or ranking."},"required":false,"description":"Guest-safe creditor claim status (WF04); never an internal acceptance or ranking.","name":"status","in":"query"},{"schema":{"type":"string","maxLength":200,"description":"Keyset cursor over the bounded register."},"required":false,"description":"Keyset cursor over the bounded register.","name":"cursor","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Bounded page of the room's creditor claim register.","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"flowId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"roomName":{"type":"string","description":"Room title (dossier vocabulary)."},"claimTitle":{"type":"string","description":"Request title (firm-written dossier vocabulary)."},"partyLabel":{"type":"string","nullable":true,"description":"Firm-entered party label of the claiming slot (WF01); null on legacy rows."},"partySlot":{"type":"string","nullable":true,"description":"Applicant slot bound to the claim; null on legacy rows."},"status":{"type":"string","enum":["not_submitted","received","correction_requested","under_review"],"description":"Guest-safe creditor claim status (WF04); never an internal acceptance or ranking."},"submittedAt":{"type":"string","nullable":true,"format":"date-time"},"dueDate":{"type":"string","nullable":true,"format":"date-time"},"evidenceCount":{"type":"integer","minimum":0,"description":"Delivered document versions of the claim; never file names."},"duplicate":{"type":"boolean","description":"Another claim in the same room filed the same normalised reference (signal only)."}},"required":["flowId","roomId","roomName","claimTitle","partyLabel","partySlot","status","submittedAt","dueDate","evidenceCount","duplicate"],"additionalProperties":false,"description":"One row of the internal creditor claim register (WF04)."}},"nextCursor":{"type":"string","nullable":true,"description":"Cursor for the next page, or null at the end."}},"required":["items","nextCursor"],"additionalProperties":false,"description":"Bounded internal creditor claim register page (WF04)."}}}},"400":{"description":"Invalid filter or cursor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: no room read permission.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant or room (PERM-02 hides existence).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/sso-sync":{"post":{"operationId":"postSsoSync","summary":"Sync the firm's Keycloak organization and IdP projection","description":"Reconciles the Keycloak organization and identity provider for the firm through the least-privilege `ddr-org-admin` client (ADR-0020 D13). Every Keycloak write commits an `identity_admin_intent` row first (guard rail 2) and the pass emits `tenant.sso_updated`. Idempotent: a second pass over an already-projected firm writes nothing. Firm admin only (`tenant.settings.update`). Not callable with an API key. Answers 409 when the firm has no complete SSO configuration and 503 when Keycloak refuses the write.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"The projection result.","content":{"application/json":{"schema":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid","description":"The caller tenant."},"idpAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Opaque IdP alias in the projection."},"organizationCreated":{"type":"boolean","description":"True when this sync created the Keycloak organization."},"identityProviderCreated":{"type":"boolean","description":"True when this sync created the Keycloak IdP."}},"required":["tenantId","idpAlias","organizationCreated","identityProviderCreated"],"description":"Result of one firm SSO projection sync."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: not a firm admin; API-key callers never (session-only).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"No complete SSO configuration to sync.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"Keycloak refused the write.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/permissions/nodes":{"post":{"operationId":"batchNodePermissions","summary":"Read the access of many nodes in one bounded request","description":"Per-group explicit assignment and effective level for up to `permissionBatchMaxTargets` nodes (default 500) in one request, in request order (T-261013-6691). Server policy is the same as `GET .../permissions/nodes/{nodeId}` per node: `permission.read` on each node (`manage` or `compliance`). Internal-only nodes report external groups as blocked (`blockedBy: internal`, ADR-0005 §6). Any node the caller may not read fails the whole request with 404, exactly like the single-node read (PERM-02); cross-tenant is 404.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"nodeIds":{"type":"array","items":{"type":"string","format":"uuid","description":"Index node id."},"minItems":1,"maxItems":500,"description":"Nodes to read; the room root is addressed by the room id. One bounded chunk."}},"required":["nodeIds"],"additionalProperties":false,"description":"Bounded batch node-permissions read (T-261013-6691)."}}}},"responses":{"200":{"description":"Per-group access for every requested node, in request order.","content":{"application/json":{"schema":{"type":"object","properties":{"nodes":{"type":"array","items":{"type":"object","properties":{"nodeId":{"type":"string","format":"uuid","description":"Node the access was read for."},"internalOnly":{"type":"boolean","description":"The node or an ancestor is internal-only (ADR-0005 §6); external groups can never be granted access here."},"groups":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":"string","format":"uuid","description":"Group id."},"groupKind":{"type":"string","enum":["internal","client","counterparty","expert","custom_external"],"description":"Group kind (ADR-0005 §4). Everything except `internal` is an external group."},"assignment":{"type":"object","nullable":true,"properties":{"groupId":{"type":"string","format":"uuid","description":"Group the assignment belongs to."},"nodeId":{"type":"string","format":"uuid","description":"Node the assignment is stored on."},"read":{"type":"string","enum":["none","view","print","download"],"description":"Read axis: none < view < print (watermarked PDF) < download (the original)."},"write":{"type":"string","enum":["none","upload_with_approval","upload","edit","manage"],"description":"Write axis: none < upload_with_approval < upload < edit < manage."},"updatedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the assignment last changed; null for a row that predates change tracking."}},"required":["groupId","nodeId","read","write","updatedAt"],"description":"The explicit assignment on this node, or null when the level is inherited."},"effectiveRead":{"type":"string","enum":["none","view","print","download"],"description":"Read axis: none < view < print (watermarked PDF) < download (the original)."},"effectiveWrite":{"type":"string","enum":["none","upload_with_approval","upload","edit","manage"],"description":"Write axis: none < upload_with_approval < upload < edit < manage."},"pendingGates":{"type":"array","items":{"type":"string","enum":["step_up_required","terms_not_accepted"],"description":"An outstanding session-completion condition: step_up_required (the session must still complete MFA step-up before node.read), terms_not_accepted (the principal must still accept the room terms)."},"description":"Session-completion conditions a member session must still satisfy before the effective level becomes readable (T-261016-43e7, probed against a basic single-strength member session of this group). Empty when a completed session could read now. The levels above keep their group-level meaning; the gates never change them."},"accessible":{"type":"boolean","description":"Whether the level is actually readable now: a granted level with no outstanding gate. False when the level is none or any gate is pending."},"inheritedFromNodeId":{"type":"string","nullable":true,"format":"uuid","description":"The nearest node that gave the effective level; null when the result is none/none."},"blockedBy":{"type":"string","nullable":true,"enum":["internal","external_ceiling","medical",null],"description":"Stop the evaluator applied (ADR-0005 §5/§6; `medical`: a special-category zone without the group flag, ADR-0056), or null."},"cannotSet":{"type":"string","nullable":true,"enum":["internal_node","external_ceiling","delegation_limit","invalid_levels",null],"description":"Why setting a level here would be refused for this group, or null when it may be set."}},"required":["groupId","groupKind","assignment","effectiveRead","effectiveWrite","pendingGates","accessible","inheritedFromNodeId","blockedBy","cannotSet"],"description":"One group and its access on one node."},"description":"Every group of the room, with its explicit and effective access on this node."}},"required":["nodeId","internalOnly","groups"],"description":"Node access response: per-group explicit and effective access (PERM-03)."},"description":"One entry per requested node, in request order. A node the caller may not read fails the whole request with 404, exactly like the single-node read (PERM-02)."}},"required":["nodes"],"description":"Bounded batch node-permissions response."}}}},"400":{"description":"Invalid batch (empty, over the cap or malformed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, a missing node or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/permissions/assignments/batch":{"post":{"operationId":"batchSetNodeAssignments","summary":"Set or clear many group assignments in one bounded request","description":"Stores or clears up to `permissionBatchMaxTargets` `(group, node) → (read, write)` cells in one request (T-261013-6691). Every change runs the same policy and store call as `PUT`/`DELETE .../permissions/nodes/{nodeId}/groups/{groupId}`: `permission.update` on the node, the ADR-0005 §5 constraints, the `canGrant` stops (`delegation_limit`, `external_ceiling`, `internal_node`), the ADR-0056 medical-zone flag and the tenant+room-scoped store with the ADR-0005 §3 last-manager guard. Instead of aborting, each change returns a truthful outcome (`applied`/`cleared`/`refused`/`not_found` with an id-only reason) so the client can show real progress and retry the rest. Cross-tenant or a hidden room is 404 before any target is touched (PERM-02). The server never runs one unrestricted multi-thousand-cell transaction: the client chunks.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"changes":{"type":"array","items":{"type":"object","properties":{"nodeId":{"type":"string","format":"uuid","description":"Index node id."},"groupId":{"type":"string","format":"uuid","description":"Group id."},"levels":{"type":"object","nullable":true,"properties":{"read":{"type":"string","enum":["none","view","print","download"],"description":"Read axis: none < view < print (watermarked PDF) < download (the original)."},"write":{"type":"string","enum":["none","upload_with_approval","upload","edit","manage"],"description":"Write axis: none < upload_with_approval < upload < edit < manage."}},"required":["read","write"],"additionalProperties":false,"description":"Levels to set on this (node, group), or null to clear the explicit assignment and inherit again."}},"required":["nodeId","groupId","levels"],"additionalProperties":false,"description":"One cell change in a bounded batch write."},"minItems":1,"maxItems":500,"description":"Cell changes to apply, bounded to `permissionBatchMaxTargets` per request."}},"required":["changes"],"additionalProperties":false,"description":"Bounded batch permission write (T-261013-6691)."}}}},"responses":{"200":{"description":"One truthful outcome per requested change, in request order.","content":{"application/json":{"schema":{"type":"object","properties":{"outcomes":{"type":"array","items":{"type":"object","properties":{"nodeId":{"type":"string","format":"uuid","description":"Index node id."},"groupId":{"type":"string","format":"uuid","description":"Group id."},"status":{"type":"string","enum":["applied","cleared","refused","not_found"],"description":"Whether the change applied, cleared, was refused, or the target is gone."},"reason":{"type":"string","nullable":true,"enum":["internal_node","external_ceiling","delegation_limit","invalid_levels","medical_zone","forbidden","last_manager","conflict",null],"description":"Why the change was refused; null when it applied or cleared."}},"required":["nodeId","groupId","status","reason"],"description":"Outcome of one cell change in a batch write."},"description":"One outcome per requested change, in request order."},"applied":{"type":"integer","minimum":0,"description":"Changes that applied (set) or cleared."},"refused":{"type":"integer","minimum":0,"description":"Changes the server refused or could not apply."}},"required":["outcomes","applied","refused"],"description":"Bounded batch permission-write response with truthful per-change outcomes."}}}},"400":{"description":"Invalid batch (empty, over the cap or malformed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `manage` on the room root, or a trial lifecycle refusal).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/permissions/bulk-apply":{"post":{"operationId":"bulkApplyPermissionPreset","summary":"Preview or apply a preset to the custom settings below a folder (PERM-UX06)","description":"Implements the PERM-UX06 \"apply to a subtree\" question with the shared `planBulkApply` rules (T-261013-8fa1). With `dryRun` (the default) it reports the counts the inline dialog shows and the exact decision per descending explicit assignment, writing nothing. With `dryRun: false` it stages the same decisions through the bounded batch policy (`permission.update` per node, `canGrant` stops, medical zone, last-manager) and returns truthful applied/refused counts. The preset `levels` is the pair the manager staged on the folder; `nodeId` may be the room root. Cross-tenant, a hidden room or an unknown group is 404 (PERM-02).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"nodeId":{"type":"string","format":"uuid","description":"Folder the preset is staged on; the room root is addressed by the room id."},"groupId":{"type":"string","format":"uuid","description":"Group id."},"levels":{"type":"object","properties":{"read":{"type":"string","enum":["none","view","print","download"],"description":"Read axis: none < view < print (watermarked PDF) < download (the original)."},"write":{"type":"string","enum":["none","upload_with_approval","upload","edit","manage"],"description":"Write axis: none < upload_with_approval < upload < edit < manage."}},"required":["read","write"],"additionalProperties":false,"description":"The preset the manager staged on the folder (PERM-UX06 N)."},"mode":{"type":"string","enum":["replace","keep_higher"],"default":"keep_higher","description":"How custom settings below the folder are treated: replace all, or keep the ones that give more access."},"keepHidden":{"type":"boolean","default":true,"description":"PERM-UX06 rule 3: keep an existing (none, none) assignment unchanged."},"dryRun":{"type":"boolean","default":true,"description":"true: only report the counts/decisions; false: apply them through the bounded batch policy."}},"required":["nodeId","groupId","levels"],"additionalProperties":false,"description":"Bounded bulk apply of a preset to the explicit settings below a folder (PERM-UX06)."}}}},"responses":{"200":{"description":"Counts and the per-descendant decisions (a dry run writes nothing).","content":{"application/json":{"schema":{"type":"object","properties":{"counts":{"type":"object","properties":{"customBelow":{"type":"integer","minimum":0,"description":"Explicit settings below the folder that were considered."},"replaced":{"type":"integer","minimum":0,"description":"Assignments removed so the node inherits the preset (rule 1/2)."},"keptHigher":{"type":"integer","minimum":0,"description":"Assignments kept (and merged per axis) because they give more access."},"keptHidden":{"type":"integer","minimum":0,"description":"Hidden (none, none) assignments kept unchanged (rule 3)."},"refused":{"type":"integer","minimum":0,"description":"Assignments left unchanged because the result would exceed a ceiling."},"skippedInternal":{"type":"integer","minimum":0,"description":"Internal rows never touched by an external group (rule 4)."}},"required":["customBelow","replaced","keptHigher","keptHidden","refused","skippedInternal"],"description":"The counts the inline PERM-UX06 dialog shows."},"decisions":{"type":"array","items":{"type":"object","properties":{"nodeId":{"type":"string","format":"uuid","description":"Index node id."},"action":{"type":"string","enum":["replaced","kept_higher","kept_hidden","skipped_internal","refused_delegation"],"description":"What the shared rules did with one descending explicit assignment (PERM-UX06 rules 1-5)."},"next":{"type":"object","nullable":true,"properties":{"read":{"type":"string","enum":["none","view","print","download"],"description":"Read axis: none < view < print (watermarked PDF) < download (the original)."},"write":{"type":"string","enum":["none","upload_with_approval","upload","edit","manage"],"description":"Write axis: none < upload_with_approval < upload < edit < manage."}},"required":["read","write"],"additionalProperties":false,"description":"The resulting explicit assignment; null means remove it so the node inherits the preset again."}},"required":["nodeId","action","next"],"description":"One descendant decision of a bulk apply (PERM-UX06)."},"description":"One decision per considered descendant, in input order."},"applied":{"type":"integer","minimum":0,"description":"Changes the server stored or cleared; 0 for a dry run, which never writes."},"refused":{"type":"integer","minimum":0,"description":"Descendants the batch policy refused at apply time."}},"required":["counts","decisions","applied","refused"],"description":"Bulk-apply preview/apply response (PERM-UX06)."}}}},"400":{"description":"Invalid body (malformed or an ADR-0005 §5-invalid preset).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (no `manage` on the node, or a trial lifecycle refusal).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, a hidden node or an unknown group).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/terms/pending":{"post":{"operationId":"listPendingTerms","summary":"List the rooms whose terms the caller still must accept","description":"Batch subset of the requested rooms with pending acceptance (T-261015-c2e7): the admin invitations panel reads this once and only lists the other rooms, instead of firing one doomed per-room request per terms-gated room. Same store and language derivation as the first-access gate, so pending here means exactly the gate would refuse the room; rooms the caller may not open are silently omitted (PERM-02: the answer never reveals that a room or its terms exist). Requires the firm-user admin audience (`user.manage`).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"roomIds":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"maxItems":500,"description":"Room ids to check, bounded per request so the client chunks."}},"required":["roomIds"],"additionalProperties":false,"description":"Rooms to check for pending terms acceptance."}}}},"responses":{"200":{"description":"Subset of the requested rooms with pending terms acceptance.","content":{"application/json":{"schema":{"type":"object","properties":{"pendingRoomIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Subset of the requested rooms whose terms the caller still must accept."}},"required":["pendingRoomIds"],"additionalProperties":false,"description":"Rooms with pending terms acceptance."}}}},"400":{"description":"Invalid request.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/medical-disclosures/{disclosureId}":{"get":{"operationId":"getDisclosure","summary":"Read one disclosure binding by id (an old link by id)","description":"`room.medical_disclosure.read` (any room member; guests read only their own subject/recipient rows, a foreign id is a no-hint 404). A withdrawn binding is 410 `DISCLOSURE_REVOKED`, a binding past its validity end is 410 `DISCLOSURE_EXPIRED`: expired and revoked bindings authorize nothing. A successful read writes no catalogue event.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"The disclosure binding id (an old link by id)."},"required":true,"description":"The disclosure binding id (an old link by id).","name":"disclosureId","in":"path"}],"responses":{"200":{"description":"The active disclosure binding, with its computed standing.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"tenantId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"nodeId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":0},"subjectPrincipalId":{"type":"string","format":"uuid"},"subjectKind":{"type":"string","enum":["user","guest"]},"recipientPrincipalId":{"type":"string","nullable":true,"format":"uuid"},"recipientKind":{"type":"string","enum":["user","guest","external"],"description":"A principal inside the room, or an external party outside of it."},"recipientCode":{"type":"string","nullable":true,"enum":["medical_expert","insurer","court","opposing_counsel","supervisor",null],"description":"The external recipient class, when the recipient is not a principal."},"purpose":{"type":"string","enum":["treatment","expert_review","insurer_claim","court_filing","second_opinion"],"description":"Why the medical information is disclosed."},"evidenceDocumentId":{"type":"string","nullable":true,"format":"uuid","description":"Supporting authority/basis document in the same room (ids only, never content)."},"evidenceReference":{"type":"string","nullable":true,"description":"Short reference for the supporting authority (mandate or file reference, ids/codes only)."},"validUntil":{"type":"string","nullable":true,"format":"date-time","description":"End of the validity of this disclosure binding; null means no expiry was set."},"revokedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the binding was withdrawn; null while the binding stands. Rows are never deleted."},"revokedBy":{"type":"string","nullable":true,"format":"uuid","description":"The firm user who withdrew the binding; null while it stands."},"revokeReason":{"type":"string","nullable":true,"description":"Why the binding was withdrawn (stored with the row, never in the audit trail)."},"status":{"type":"string","enum":["active","expired","revoked"],"description":"Standing of the binding, computed when the row is read."},"authorizedBy":{"type":"string","format":"uuid","description":"The firm user who authorized the disclosure."},"authorizedAt":{"type":"string","format":"date-time"},"disclosedAt":{"type":"string","format":"date-time"}},"required":["id","tenantId","roomId","documentId","nodeId","versionNo","subjectPrincipalId","subjectKind","recipientPrincipalId","recipientKind","recipientCode","purpose","evidenceDocumentId","evidenceReference","validUntil","revokedAt","revokedBy","revokeReason","status","authorizedBy","authorizedAt","disclosedAt"],"description":"One targeted medical disclosure: what went to whom, when, for which purpose."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Visible, but the caller lacks the level or role.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, node, group or client; no access; cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"410":{"description":"`DISCLOSURE_REVOKED` or `DISCLOSURE_EXPIRED`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/medical-disclosures/{disclosureId}/revoke":{"post":{"operationId":"revokeDisclosure","summary":"Withdraw one disclosure binding (revocation)","description":"Reuses `room.medical_disclosure.log` (`manage` on the room, firm users, step-up): withdrawing is a manage-level content decision like logging. Dates the binding instead of deleting it, so the history stays auditable; withdrawing twice is 409 `DISCLOSURE_ALREADY_REVOKED`. Writes `medical_disclosure.revoked` (disclosure id only; the free-text reason never reaches the audit trail).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"The disclosure binding id (an old link by id)."},"required":true,"description":"The disclosure binding id (an old link by id).","name":"disclosureId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","nullable":true,"minLength":1,"maxLength":500,"description":"Why the binding is withdrawn (stored with the row, never in the audit trail)."}},"additionalProperties":false,"description":"Withdraw one targeted medical disclosure binding (`room.medical_disclosure.log`)."}}}},"responses":{"200":{"description":"The withdrawn disclosure binding.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"tenantId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"documentId":{"type":"string","format":"uuid"},"nodeId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":0},"subjectPrincipalId":{"type":"string","format":"uuid"},"subjectKind":{"type":"string","enum":["user","guest"]},"recipientPrincipalId":{"type":"string","nullable":true,"format":"uuid"},"recipientKind":{"type":"string","enum":["user","guest","external"],"description":"A principal inside the room, or an external party outside of it."},"recipientCode":{"type":"string","nullable":true,"enum":["medical_expert","insurer","court","opposing_counsel","supervisor",null],"description":"The external recipient class, when the recipient is not a principal."},"purpose":{"type":"string","enum":["treatment","expert_review","insurer_claim","court_filing","second_opinion"],"description":"Why the medical information is disclosed."},"evidenceDocumentId":{"type":"string","nullable":true,"format":"uuid","description":"Supporting authority/basis document in the same room (ids only, never content)."},"evidenceReference":{"type":"string","nullable":true,"description":"Short reference for the supporting authority (mandate or file reference, ids/codes only)."},"validUntil":{"type":"string","nullable":true,"format":"date-time","description":"End of the validity of this disclosure binding; null means no expiry was set."},"revokedAt":{"type":"string","nullable":true,"format":"date-time","description":"When the binding was withdrawn; null while the binding stands. Rows are never deleted."},"revokedBy":{"type":"string","nullable":true,"format":"uuid","description":"The firm user who withdrew the binding; null while it stands."},"revokeReason":{"type":"string","nullable":true,"description":"Why the binding was withdrawn (stored with the row, never in the audit trail)."},"status":{"type":"string","enum":["active","expired","revoked"],"description":"Standing of the binding, computed when the row is read."},"authorizedBy":{"type":"string","format":"uuid","description":"The firm user who authorized the disclosure."},"authorizedAt":{"type":"string","format":"date-time"},"disclosedAt":{"type":"string","format":"date-time"}},"required":["id","tenantId","roomId","documentId","nodeId","versionNo","subjectPrincipalId","subjectKind","recipientPrincipalId","recipientKind","recipientCode","purpose","evidenceDocumentId","evidenceReference","validUntil","revokedAt","revokedBy","revokeReason","status","authorizedBy","authorizedAt","disclosedAt"],"description":"One targeted medical disclosure: what went to whom, when, for which purpose."}}}},"400":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"`STEP_UP_REQUIRED`: fresh authentication is required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Visible, but the caller lacks the level or role.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room, node, group or client; no access; cross-tenant (PERM-02).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"`DISCLOSURE_ALREADY_REVOKED`: already withdrawn.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/versions/compare":{"get":{"operationId":"compareDocumentVersions","summary":"Compare two versions of a document","description":"Word-level text diff per page from `document_page_text` of the two versions (`from`, `to` as 1-based version numbers). Same authorization and visibility as `listDocumentVersions`: both versions must be readable under the same `node.read` rule, otherwise 404 with no content. A side with no extractable text yields `status: not_comparable` with a `reason` naming the empty side. 403 when the trial ended.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"},{"schema":{"type":"string","pattern":"^[1-9][0-9]{0,8}$","description":"1-based number of the base version."},"required":true,"description":"1-based number of the base version.","name":"from","in":"query"},{"schema":{"type":"string","pattern":"^[1-9][0-9]{0,8}$","description":"1-based number of the version to compare against the base."},"required":true,"description":"1-based number of the version to compare against the base.","name":"to","in":"query"}],"responses":{"200":{"description":"The per-page word-level comparison.","content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid","description":"Compared document."},"fromVersionNo":{"type":"integer","minimum":1,"description":"1-based number of the base version."},"toVersionNo":{"type":"integer","minimum":1,"description":"1-based number of the compared version."},"fromVersionId":{"type":"string","format":"uuid","description":"Base version id."},"toVersionId":{"type":"string","format":"uuid","description":"Compared version id."},"status":{"type":"string","enum":["compared","not_comparable"],"description":"Whether both sides had text to diff."},"reason":{"type":"string","nullable":true,"enum":["both_empty","from_empty","to_empty",null],"description":"Null when compared; names the side without extractable text otherwise."},"pages":{"type":"array","items":{"type":"object","properties":{"pageNo":{"type":"integer","minimum":1,"description":"1-based page number."},"changed":{"type":"boolean","description":"Whether the page differs between the two versions."},"aText":{"type":"string","nullable":true,"description":"Base-side page body; null when the page exists only on the other side."},"bText":{"type":"string","nullable":true,"description":"Target-side page body; null when the page exists only on the other side."},"ops":{"type":"array","items":{"type":"object","properties":{"op":{"type":"string","enum":["same","del","ins"],"description":"Unchanged, removed-from-base, added-in-target word run."},"text":{"type":"string","description":"Space-joined words of this run (response content only, never logged)."}},"required":["op","text"],"description":"One merged word run of a page diff."},"description":"Merged word-level runs rendering the diff."},"truncated":{"type":"boolean","description":"True when the page was capped before diffing."}},"required":["pageNo","changed","aText","bText","ops","truncated"],"description":"One compared page."},"description":"Per-page texts and word-level runs; empty when not comparable."},"stats":{"type":"object","properties":{"pages":{"type":"integer","minimum":0},"changedPages":{"type":"integer","minimum":0},"addedWords":{"type":"integer","minimum":0},"removedWords":{"type":"integer","minimum":0}},"required":["pages","changedPages","addedWords","removedWords"],"description":"Diff totals across the compared pages."}},"required":["documentId","fromVersionNo","toVersionNo","fromVersionId","toVersionId","status","reason","pages","stats"],"description":"Word-level comparison of two versions of one document (DOC-21)."}}}},"400":{"description":"Invalid version numbers.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (trial ended).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/permissions/preview":{"get":{"operationId":"previewPermissionsAs","summary":"Preview the room as a group or user","description":"Read-only projection for room managers: the caller needs `permission.preview` (`manage` on the room root, or `firm_admin`; users only, deliberately no compliance alternative), so a non-manager is refused with 404 and learns nothing (PERM-02). The target (exactly one of principalId, groupId) is evaluated with the same policy evaluator as a real request of that principal, intersected with what the caller sees. Answers ids, kinds and levels only, never document bytes, page text, titles, names or thread content. A served preview writes the ids-only `permission.previewed` audit event; a refused preview writes nothing.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Principal to preview (user or guest of the room)."},"required":false,"description":"Principal to preview (user or guest of the room).","name":"principalId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Group to preview (a member holding only this group)."},"required":false,"description":"Group to preview (a member holding only this group).","name":"groupId","in":"query"}],"responses":{"200":{"description":"The previewed target and the nodes both the target and the caller see.","content":{"application/json":{"schema":{"type":"object","properties":{"target":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["principal"]},"principalId":{"type":"string","format":"uuid","description":"Previewed principal id."}},"required":["kind","principalId"],"description":"A principal preview."},{"type":"object","properties":{"kind":{"type":"string","enum":["group"]},"groupId":{"type":"string","format":"uuid","description":"Previewed group id."}},"required":["kind","groupId"],"description":"A group preview (a member holding only this group)."}],"description":"The previewed target."},"truncated":{"type":"boolean","description":"True when the room skeleton exceeded the server cap and the view is partial."},"nodes":{"type":"array","items":{"type":"object","properties":{"nodeId":{"type":"string","format":"uuid","description":"Visible node id."},"kind":{"type":"string","enum":["folder","document","placeholder"],"description":"Node kind (the skeleton carries no titles)."},"read":{"type":"string","enum":["none","view","print","download"],"description":"The target's effective read level on this node."},"write":{"type":"string","enum":["none","upload_with_approval","upload","edit","manage"],"description":"The target's effective write level on this node."}},"required":["nodeId","kind","read","write"],"additionalProperties":false,"description":"One visible node of a 'view as' projection: ids, kinds and levels only, never content."},"description":"Nodes both the target and the previewing manager see, with effective levels."}},"required":["target","truncated","nodes"],"description":"'View as' preview response: the target, the truncation flag and the visible nodes."}}}},"400":{"description":"Invalid query (not exactly one of principalId, groupId).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, an unknown target or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"Temporarily unavailable (the preview audit event could not be recorded).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/file-shares":{"post":{"operationId":"createFileShare","summary":"Create a version-pinned secure file link","description":"Room managers with original download rights only. At most 50 files, 30 days and 1000 total file downloads. Returns the URL capability and separate random access code once; only hashes persist. Restricted, internal and watermarked-only files, stronger guest authentication and mandatory room terms require the existing guest flow. The capability is forwardable and does not identify its recipient.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"documentIds":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"maxItems":50},"expiresAt":{"type":"string","format":"date-time"},"maxDownloads":{"type":"integer","minimum":1,"maximum":1000},"label":{"type":"string","maxLength":120,"default":""}},"required":["documentIds","expiresAt","maxDownloads"],"additionalProperties":false}}}},"responses":{"201":{"description":"Link and code, shown once.","content":{"application/json":{"schema":{"type":"object","properties":{"share":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"},"maxDownloads":{"type":"integer"},"downloadsUsed":{"type":"integer"},"completedDownloads":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"revokedAt":{"type":"string","nullable":true,"format":"date-time"},"lastDownloadedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","label","expiresAt","maxDownloads","downloadsUsed","completedDownloads","createdAt","revokedAt","lastDownloadedAt"],"additionalProperties":false},"url":{"type":"string"},"accessCode":{"type":"string"}},"required":["share","url","accessCode"],"additionalProperties":false}}}},"400":{"description":"Invalid input or expired cursor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Sign-in required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Access denied or room terms required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unavailable or no access; existence is concealed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Use the authenticated guest flow for this room.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"Storage or audit unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"get":{"operationId":"listFileShares","summary":"List own file links and completed server transfers","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"Latest 100 own links; no secret recovery. A transfer is not proof of reading.","content":{"application/json":{"schema":{"type":"object","properties":{"shares":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"},"maxDownloads":{"type":"integer"},"downloadsUsed":{"type":"integer"},"completedDownloads":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"revokedAt":{"type":"string","nullable":true,"format":"date-time"},"lastDownloadedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","label","expiresAt","maxDownloads","downloadsUsed","completedDownloads","createdAt","revokedAt","lastDownloadedAt"],"additionalProperties":false}},"truncated":{"type":"boolean"}},"required":["shares","truncated"],"additionalProperties":false}}}},"400":{"description":"Invalid input or expired cursor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Sign-in required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Access denied or room terms required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unavailable or no access; existence is concealed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Use the authenticated guest flow for this room.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"Storage or audit unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/file-shares/{shareId}/revoke":{"post":{"operationId":"revokeFileShare","summary":"Revoke an own file link","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"shareId","in":"path"}],"responses":{"204":{"description":"Revoked."},"400":{"description":"Invalid input or expired cursor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Sign-in required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Access denied or room terms required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unavailable or no access; existence is concealed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Use the authenticated guest flow for this room.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"Storage or audit unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/public/file-shares/{tenantId}/{shareId}/open":{"post":{"operationId":"openFileShare","summary":"Open a file link using both capabilities","description":"Rechecks current source permissions and room policy. Credentials in the request body only. Wrong, expired, exhausted and revoked links give the same unavailable response.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"shareId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$"},"accessCode":{"type":"string","pattern":"^[A-Za-z0-9_-]{16}$"}},"required":["token","accessCode"],"additionalProperties":false}}}},"responses":{"200":{"description":"Shared versions and remaining download budget.","content":{"application/json":{"schema":{"type":"object","properties":{"share":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"},"maxDownloads":{"type":"integer"},"downloadsUsed":{"type":"integer"},"completedDownloads":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"revokedAt":{"type":"string","nullable":true,"format":"date-time"},"lastDownloadedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","label","expiresAt","maxDownloads","downloadsUsed","completedDownloads","createdAt","revokedAt","lastDownloadedAt"],"additionalProperties":false},"files":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid"},"versionId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer","minimum":0,"exclusiveMinimum":true},"name":{"type":"string"},"size":{"type":"number","minimum":0}},"required":["documentId","versionId","versionNo","name","size"],"additionalProperties":false}}},"required":["share","files"],"additionalProperties":false}}}},"400":{"description":"Invalid input or expired cursor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Sign-in required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Access denied or room terms required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unavailable or no access; existence is concealed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Use the authenticated guest flow for this room.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"Storage or audit unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/public/file-shares/{tenantId}/{shareId}/download":{"post":{"operationId":"downloadFileShare","summary":"Stream one pinned original with an atomic download reservation","description":"Validates both capabilities and current source permissions. A successful server transfer records a receipt; interrupted transfers refund their reserved slot. Unfinished transfers after a crash conservatively consume a slot.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"shareId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$"},"accessCode":{"type":"string","pattern":"^[A-Za-z0-9_-]{16}$"},"documentId":{"type":"string","format":"uuid"}},"required":["token","accessCode","documentId"],"additionalProperties":false}},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"token":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$"},"accessCode":{"type":"string","pattern":"^[A-Za-z0-9_-]{16}$"},"documentId":{"type":"string","format":"uuid"}},"required":["token","accessCode","documentId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Integrity-checked attachment.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid input or expired cursor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Sign-in required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Access denied or room terms required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unavailable or no access; existence is concealed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Use the authenticated guest flow for this room.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"Storage or audit unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/document-inbox":{"get":{"operationId":"listDocumentInbox","summary":"Personal new, unread or approval-pending documents","description":"Current user rights and room terms apply before returning titles. Bounded scans of 100 candidates, opaque short-lived per-principal cursor. Read receipts belong to an exact principal and version; a new version is unread. New means uploaded in the last seven days. Pending includes only uploads the caller may approve.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","enum":["new","unread","pending"],"default":"unread"},"required":false,"name":"filter","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"roomId","in":"query"},{"schema":{"type":"string","minLength":32,"maxLength":1024},"required":false,"name":"after","in":"query"}],"responses":{"200":{"description":"Accessible personal documents; load next scan when hasMore.","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid"},"nodeId":{"type":"string","format":"uuid"},"roomId":{"type":"string","format":"uuid"},"roomName":{"type":"string"},"name":{"type":"string"},"versionId":{"type":"string","format":"uuid"},"versionNo":{"type":"integer"},"uploadedAt":{"type":"string","format":"date-time"},"read":{"type":"boolean"},"pending":{"type":"boolean"},"canApprove":{"type":"boolean"}},"required":["documentId","nodeId","roomId","roomName","name","versionId","versionNo","uploadedAt","read","pending","canApprove"],"additionalProperties":false}},"next":{"type":"string","nullable":true},"hasMore":{"type":"boolean"}},"required":["items","next","hasMore"],"additionalProperties":false}}}},"400":{"description":"Invalid input or expired cursor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Sign-in required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Access denied or room terms required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unavailable or no access; existence is concealed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Use the authenticated guest flow for this room.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"Storage or audit unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/read-state":{"post":{"operationId":"setDocumentReadState","summary":"Mark the current version read or unread for the signed-in user","description":"Requires current document view rights. Separate from review and compliance. Metadata fetching and prefetching never mark a document read.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"documentId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid"},"read":{"type":"boolean"}},"required":["versionId","read"],"additionalProperties":false}}}},"responses":{"204":{"description":"Personal read state stored."},"400":{"description":"Invalid input or expired cursor.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Sign-in required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Access denied or room terms required.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unavailable or no access; existence is concealed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"Use the authenticated guest flow for this room.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"Storage or audit unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/outlook-addin/connections":{"post":{"operationId":"connectOutlookAddin","summary":"Connect the Outlook add-in for the signed-in user","description":"Creates an API key for the caller with the single scope `outlook.addin` (30 days) and returns the secret once. Firm users only, with a signed-in session; never with an API key. Writes `api_key.created`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"201":{"description":"The key and its secret (once).","content":{"application/json":{"schema":{"type":"object","properties":{"keyId":{"type":"string","format":"uuid","description":"Id of the created key, as listed under Beheer > Integraties."},"secret":{"type":"string","pattern":"^ddr_[A-Za-z0-9_-]{84}$","description":"The key secret, shown exactly once."},"expiresAt":{"type":"string","format":"date-time","description":"When the key stops working."}},"required":["keyId","secret","expiresAt"],"description":"The Outlook add-in key of the caller (secret once)."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Not a firm user, or called with an API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown or foreign tenant.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/outlook-addin/connections/current":{"delete":{"operationId":"disconnectOutlookAddin","summary":"Disconnect the Outlook add-in (revoke the calling key)","description":"Called with the add-in key itself (`Authorization: Bearer ddr_…`, scope `outlook.addin`); revokes that key. Writes `api_key.revoked`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"204":{"description":"The key is revoked."},"401":{"description":"No valid add-in key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Not an add-in key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown or foreign tenant.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/office-sessions":{"post":{"operationId":"createOfficeSession","summary":"Open a document in the self-hosted office editor","description":"Firm users only. `view` needs `document.view` and `document.download`; `edit` also needs `document.version.create`. Office files only (Word, Excel, PowerPoint, OpenDocument, RTF, CSV). Returns the editor URL and an access token valid for 10 hours. Writes `office_session.opened`. Every save in the editor stores a new version.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"documentId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"mode":{"type":"string","enum":["view","edit"],"description":"Read-only or editing session."}},"required":["mode"],"additionalProperties":false,"description":"Open a document in the office editor."}}}},"responses":{"201":{"description":"The editor session.","content":{"application/json":{"schema":{"type":"object","properties":{"editorUrl":{"type":"string","format":"uri","description":"Form action of the editor frame (includes the WOPI source)."},"accessToken":{"type":"string","minLength":40,"maxLength":200,"description":"Posted to the editor as `access_token`; never in a URL."},"accessTokenTtl":{"type":"integer","description":"Token expiry as Unix milliseconds (WOPI `access_token_ttl`)."},"mode":{"type":"string","enum":["view","edit"],"description":"Read-only or editing session."}},"required":["editorUrl","accessToken","accessTokenTtl","mode"],"description":"An office editor session for the caller."}}}},"400":{"description":"Invalid body, or not an office file.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Not allowed for this document or mode.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown document or no access (concealed).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"The office editor is not configured (`OFFICE_ONLINE_UNAVAILABLE`).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/diagnostics":{"get":{"operationId":"getFirmDiagnostics","summary":"Operational failure counts of the office","description":"What failed in the office over the last 24 hours or 7 days: document versions whose processing failed, upload sessions that never arrived and can no longer be resumed, and invitation e-mails the platform could not send — each as a count with the platform failure codes behind it, largest first. `healthy` says outright that nothing failed. Counts and codes only, over the office's own rows: no file name, document title, room or client name, recipient address or principal, because the administrator reading this page may hold no rights in the rooms the failures happened in. To act on one failure, use the endpoint that decides per room (the processing status of a version, the invitation row, the room's pending approvals). `tenant.diagnostics.read`: firm admins and compliance. No step-up (nothing is changed). A guest, another firm role or a principal of another tenant gets 404 NOT_FOUND (PERM-02). Navigation read: no audit event on success.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","enum":["24h","7d"],"description":"How far back the counts reach: the last 24 hours (default) or the last 7 days."},"required":false,"description":"How far back the counts reach: the last 24 hours (default) or the last 7 days.","name":"window","in":"query"}],"responses":{"200":{"description":"The failure counts for the window.","content":{"application/json":{"schema":{"type":"object","properties":{"window":{"type":"string","enum":["24h","7d"],"description":"How far back the counts reach: the last 24 hours (default) or the last 7 days."},"since":{"type":"string","format":"date-time","description":"Start of the window (UTC, ISO-8601)."},"generatedAt":{"type":"string","format":"date-time"},"processing":{"type":"object","properties":{"total":{"type":"integer","minimum":0,"description":"Document versions whose processing failed in the window."},"codes":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":64,"description":"Platform failure code."},"count":{"type":"integer","minimum":1}},"required":["code","count"],"additionalProperties":false,"description":"How often one failure code occurred in the window."},"maxItems":10,"description":"The most frequent codes, largest first; fewer than `total` when codes were folded."}},"required":["total","codes"],"additionalProperties":false,"description":"Document versions whose processing failed"},"uploads":{"type":"object","properties":{"abandoned":{"type":"integer","minimum":0,"description":"Upload sessions started in the window that never finished and can no longer be resumed (expired). An upload still within its resume window is not a failure and is not counted."}},"required":["abandoned"],"additionalProperties":false,"description":"Uploads that never arrived"},"mail":{"type":"object","properties":{"total":{"type":"integer","minimum":0,"description":"Invitation e-mails the platform could not send in the window."},"codes":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":64,"description":"Platform failure code."},"count":{"type":"integer","minimum":1}},"required":["code","count"],"additionalProperties":false,"description":"How often one failure code occurred in the window."},"maxItems":10,"description":"The most frequent codes, largest first; fewer than `total` when codes were folded."}},"required":["total","codes"],"additionalProperties":false,"description":"Invitation e-mails the platform could not send"},"healthy":{"type":"boolean","description":"No failures of any class in the window."}},"required":["window","since","generatedAt","processing","uploads","mail","healthy"],"additionalProperties":false,"description":"Operational failure counts of the office over one window (counts and platform codes only, never content)."}}}},"400":{"description":"Unknown window.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not a firm admin or compliance officer of this tenant (including cross-tenant), or no database.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/insights/people":{"get":{"operationId":"getRoomPeopleInsights","summary":"Room engagement per person","description":"Same access as `getRoomInsights`. Per person over the whole room: documents and pages viewed, reading time, active days (revisits), downloads and prints and suspicious viewer signals from the audit trail, and the last activity. At most 500 people, most reading time first. Not audited (a read, like the room audit trail).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","enum":["7","30","90","365"],"description":"Period in days, ending today (Europe/Amsterdam). Default 30."},"required":false,"description":"Period in days, ending today (Europe/Amsterdam). Default 30.","name":"days","in":"query"}],"responses":{"200":{"description":"The people insights for the period.","content":{"application/json":{"schema":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid"},"days":{"type":"integer","minimum":1},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"groups":{"type":"array","items":{"type":"object","properties":{"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group; null for firm users without a group in this room."},"name":{"type":"string","nullable":true,"description":"Group name; null for an unnamed or no group."},"kind":{"type":"string","nullable":true,"enum":["internal","client","counterparty","expert","custom_external",null],"description":"Group kind (ADR-0005 §4). Everything except `internal` is an external group."},"external":{"type":"boolean","description":"True for every group kind except internal."},"principals":{"type":"integer","minimum":0,"description":"People of the group with any engagement."},"documentsViewed":{"type":"integer","minimum":0},"totalSeconds":{"type":"integer","minimum":0},"lastActivityAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["groupId","name","kind","external","principals","documentsViewed","totalSeconds","lastActivityAt"]}},"people":{"type":"array","items":{"type":"object","properties":{"principalId":{"type":"string","format":"uuid"},"displayName":{"type":"string","nullable":true},"kind":{"type":"string","enum":["user","guest"]},"groupId":{"type":"string","nullable":true,"format":"uuid","description":"Room group; null for firm users without a group in this room."},"documentsViewed":{"type":"integer","minimum":0},"pagesViewed":{"type":"integer","minimum":0,"description":"Distinct (document, page) pairs with reading time."},"seconds":{"type":"integer","minimum":0},"activeDays":{"type":"integer","minimum":0,"description":"Distinct calendar days with reading time (Europe/Amsterdam): more than one means the person came back."},"downloads":{"type":"integer","minimum":0,"description":"Downloads and prints in the room in the period (audit trail)."},"protectionEvents":{"type":"integer","minimum":0,"description":"Suspicious viewer signals (`document.protection_event`) in the room in the period."},"lastActivityAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["principalId","displayName","kind","groupId","documentsViewed","pagesViewed","seconds","activeDays","downloads","protectionEvents","lastActivityAt"]},"description":"At most 500 people, most reading time first."}},"required":["roomId","days","from","to","groups","people"],"description":"Engagement per person over the whole room for the period."}}}},"400":{"description":"Invalid query.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or document, a guest, or a firm user without `audit.read_room` on the room (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/insights/qa":{"get":{"operationId":"getRoomQaInsights","summary":"Q&A turnaround per asking group","description":"Same access as `getRoomInsights`. For the questions asked in the period, per asking group and in total: asked, answered (published), open, declined, overdue, and the median and 90th percentile hours from asked to published. `enabled: false` when Q&A is off in the room.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","enum":["7","30","90","365"],"description":"Period in days, ending today (Europe/Amsterdam). Default 30."},"required":false,"description":"Period in days, ending today (Europe/Amsterdam). Default 30.","name":"days","in":"query"}],"responses":{"200":{"description":"The Q&A turnaround for the period.","content":{"application/json":{"schema":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid"},"days":{"type":"integer","minimum":1},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"enabled":{"type":"boolean","description":"Q&A is switched on in the room; false returns empty totals."},"total":{"type":"object","properties":{"asked":{"type":"integer","minimum":0,"description":"Questions asked in the period."},"answered":{"type":"integer","minimum":0,"description":"Of those, published to the asking group."},"open":{"type":"integer","minimum":0,"description":"Of those, not yet published, declined or closed."},"declined":{"type":"integer","minimum":0},"overdue":{"type":"integer","minimum":0,"description":"Open questions past their due date."},"medianHours":{"type":"number","nullable":true,"minimum":0,"description":"Median hours from asked to published; null without answers."},"p90Hours":{"type":"number","nullable":true,"minimum":0,"description":"90th percentile hours from asked to published."}},"required":["asked","answered","open","declined","overdue","medianHours","p90Hours"]},"groups":{"type":"array","items":{"type":"object","properties":{"asked":{"type":"integer","minimum":0,"description":"Questions asked in the period."},"answered":{"type":"integer","minimum":0,"description":"Of those, published to the asking group."},"open":{"type":"integer","minimum":0,"description":"Of those, not yet published, declined or closed."},"declined":{"type":"integer","minimum":0},"overdue":{"type":"integer","minimum":0,"description":"Open questions past their due date."},"medianHours":{"type":"number","nullable":true,"minimum":0,"description":"Median hours from asked to published; null without answers."},"p90Hours":{"type":"number","nullable":true,"minimum":0,"description":"90th percentile hours from asked to published."},"groupId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"kind":{"type":"string","nullable":true,"enum":["internal","client","counterparty","expert","custom_external",null],"description":"Group kind (ADR-0005 §4). Everything except `internal` is an external group."}},"required":["asked","answered","open","declined","overdue","medianHours","p90Hours","groupId","name","kind"]},"description":"Asking groups with questions in the period, most asked first."}},"required":["roomId","days","from","to","enabled","total","groups"],"description":"Q&A turnaround per asking group for the period."}}}},"400":{"description":"Invalid query.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Unknown tenant, room or document, a guest, or a firm user without `audit.read_room` on the room (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/documents/{documentId}/viewer-events":{"post":{"operationId":"reportViewerProtectionEvent","summary":"Report a suspicious viewer signal (screenshot key, focus loss, print or copy attempt)","description":"Requires `node.read` and `document.view` on the document for the caller (firm user or guest); otherwise 404 (PERM-02). When the caller’s effective viewer protection in the room is not `off`, writes `document.protection_event` (kind, page and version only) to the audit trail as the caller; with `off` nothing is written. A signal is a hint, never proof. Rate limited per principal (20 per minute).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Document id."},"required":true,"description":"Document id.","name":"documentId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["focus_lost","screenshot_key","print_attempt","copy_attempt","context_menu","devtools_open"],"description":"Suspicious viewer signal: the window lost focus, a screenshot key, a print or copy attempt, the context menu, or the devtools heuristic. A hint, never proof."},"pageNo":{"type":"integer","minimum":1,"maximum":100000,"description":"Page on screen, 1-based."},"versionNo":{"type":"integer","minimum":1,"description":"Version shown; default the current version."}},"required":["kind"],"additionalProperties":false,"description":"One suspicious viewer signal, written to the audit trail as `document.protection_event`."}}}},"responses":{"204":{"description":"Recorded, or nothing to record (protection off)."},"400":{"description":"Invalid body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant or without access).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"429":{"description":"Too many signals; see Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"503":{"description":"The audit event could not be written.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/me/api-keys":{"get":{"operationId":"listMyApiKeys","summary":"List my own API keys","description":"The keys the caller created for themselves (personal keys and the Outlook add-in key), newest first; never a colleague’s key and never the secret. Every firm role (`api_key.read_own`). Not callable with an API key.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"My keys, newest first.","content":{"application/json":{"schema":{"type":"object","properties":{"keys":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"API key id."},"name":{"type":"string","minLength":1,"maxLength":80},"prefix":{"type":"string","minLength":4,"maxLength":16},"scopes":{"type":"array","items":{"type":"string","enum":["rooms.read","rooms.write","documents.read","documents.upload","documents.write","flows.read","flows.write","exhibits.read","exhibits.write","messaging.read","messaging.write","qa.read","qa.write","team.read","team.write","office.read","office.write","audit.read","billing.read","outlook.addin"],"description":"One API key scope."},"minItems":1},"createdBy":{"type":"string","format":"uuid","description":"Principal id of the creating firm admin; the key acts as this principal."},"createdAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"},"lastUsedAt":{"type":"string","nullable":true,"format":"date-time"},"revokedAt":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["active","expired","revoked"]},"roomIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":50,"description":"Data rooms the key is limited to (ADR-0067); empty means firm-wide."},"personal":{"type":"boolean","description":"A member created this key for themselves under Mijn koppelingen (ADR-0067 D4): read-only scopes, refused while the firm switch is off."},"allowedCidrs":{"type":"array","items":{"type":"string"},"maxItems":20,"description":"Networks the key may be used from (ADR-0067 D6); empty means any address."},"rateLimitPerMinute":{"type":"integer","nullable":true,"minimum":1,"maximum":1000,"description":"Requests per minute for this key; null means the platform default (300)."},"rotatedFrom":{"type":"string","nullable":true,"format":"uuid","description":"The key this one replaced by rotation (ADR-0067 D6), if any."}},"required":["id","name","prefix","scopes","createdBy","createdAt","expiresAt","lastUsedAt","revokedAt","status","roomIds","personal","allowedCidrs","rateLimitPerMinute","rotatedFrom"],"description":"One API key of the firm (never the secret)."},"description":"API keys of the firm, newest first."},"truncated":{"type":"boolean","description":"True when more keys exist than were returned (the list is partial)."}},"required":["keys","truncated"]}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: guests, support, services and API keys never; `MEMBER_INTEGRATIONS_DISABLED` while the firm has member integrations switched off.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}},"post":{"operationId":"createMyApiKey","summary":"Create a personal API key (secret shown once)","description":"Every firm role (`api_key.manage_own`) while the firm allows member integrations. The key acts as the caller with at most the read scopes the firm whitelisted (plus `documents.upload`), for at most the firm lifetime ceiling, and (by default) only in the rooms named, each of which needs the caller as a member. Refusals: `MEMBER_INTEGRATIONS_DISABLED` (403), `SCOPE_NOT_ALLOWED` (400: scope outside the whitelist, lifetime over the ceiling, or no rooms while rooms are required), `KEY_LIMIT_REACHED` (409), an unknown room 404. Audited as `api_key.created` with `self: true`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"scopes":{"type":"array","items":{"type":"string","enum":["rooms.read","documents.read","documents.upload","flows.read","exhibits.read","messaging.read","qa.read","team.read","office.read"],"description":"One scope a personal key may hold (ADR-0067 D4: read-only plus documents.upload)."},"minItems":1,"maxItems":9},"expiresInDays":{"type":"integer","minimum":1,"maximum":365,"description":"Lifetime in days; at most the firm ceiling (memberApiKeyMaxDays, default 90)."},"roomIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":50,"description":"Rooms the key is limited to; required (non-empty) while the firm requires room-scoped personal keys. Each room needs the caller as a member."}},"required":["name","scopes","expiresInDays"],"additionalProperties":false,"description":"Create a personal API key (secret shown once)."}}}},"responses":{"201":{"description":"The key and its secret.","content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"API key id."},"name":{"type":"string","minLength":1,"maxLength":80},"prefix":{"type":"string","minLength":4,"maxLength":16},"scopes":{"type":"array","items":{"type":"string","enum":["rooms.read","rooms.write","documents.read","documents.upload","documents.write","flows.read","flows.write","exhibits.read","exhibits.write","messaging.read","messaging.write","qa.read","qa.write","team.read","team.write","office.read","office.write","audit.read","billing.read","outlook.addin"],"description":"One API key scope."},"minItems":1},"createdBy":{"type":"string","format":"uuid","description":"Principal id of the creating firm admin; the key acts as this principal."},"createdAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"},"lastUsedAt":{"type":"string","nullable":true,"format":"date-time"},"revokedAt":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["active","expired","revoked"]},"roomIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":50,"description":"Data rooms the key is limited to (ADR-0067); empty means firm-wide."},"personal":{"type":"boolean","description":"A member created this key for themselves under Mijn koppelingen (ADR-0067 D4): read-only scopes, refused while the firm switch is off."},"allowedCidrs":{"type":"array","items":{"type":"string"},"maxItems":20,"description":"Networks the key may be used from (ADR-0067 D6); empty means any address."},"rateLimitPerMinute":{"type":"integer","nullable":true,"minimum":1,"maximum":1000,"description":"Requests per minute for this key; null means the platform default (300)."},"rotatedFrom":{"type":"string","nullable":true,"format":"uuid","description":"The key this one replaced by rotation (ADR-0067 D6), if any."}},"required":["id","name","prefix","scopes","createdBy","createdAt","expiresAt","lastUsedAt","revokedAt","status","roomIds","personal","allowedCidrs","rateLimitPerMinute","rotatedFrom"],"description":"One API key of the firm (never the secret)."},"secret":{"type":"string","pattern":"^ddr_[A-Za-z0-9_-]{84}$"}},"required":["key","secret"],"description":"The created key and its secret (once)."}}}},"400":{"description":"Invalid body, or outside the firm limits (`SCOPE_NOT_ALLOWED`).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: guests, support, services and API keys never; `MEMBER_INTEGRATIONS_DISABLED` while the firm has member integrations switched off.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"409":{"description":"The active personal-key ceiling is reached (`KEY_LIMIT_REACHED`).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/me/api-keys/{keyId}":{"delete":{"operationId":"revokeMyApiKey","summary":"Revoke one of my API keys","description":"Every firm role (`api_key.manage_own`). Only a key the caller created; a colleague’s key is 404. Revocation works even while member integrations are switched off. Audited as `api_key.revoked`.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"API key id."},"required":true,"description":"API key id.","name":"keyId","in":"path"}],"responses":{"204":{"description":"Revoked (or already revoked)."},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden: guests, support, services and API keys never; `MEMBER_INTEGRATIONS_DISABLED` while the firm has member integrations switched off.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/api-keys/{keyId}/rotate":{"post":{"operationId":"rotateApiKey","summary":"Rotate an API key (new secret, old one valid for a grace period)","description":"Firm admin only (`api_key.manage`). Issues a new secret with the same name, scopes, rooms, networks and rate limit, acting as the same creator; the old key stays valid for `graceDays` (default 7, max 30, never past its own expiry). Only a key the admin created can be rotated: a key acts as its creator, so an admin never receives a secret that acts as a colleague. A revoked, expired or foreign key is 404. Audited as `api_key.rotated` and `api_key.created` (with `rotated_from`).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"API key id."},"required":true,"description":"API key id.","name":"keyId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"graceDays":{"type":"integer","minimum":0,"maximum":30,"description":"Days the old key stays valid (0-30, default 7)."}},"additionalProperties":false,"description":"Rotate an API key."}}}},"responses":{"201":{"description":"The new key and its secret (once).","content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"API key id."},"name":{"type":"string","minLength":1,"maxLength":80},"prefix":{"type":"string","minLength":4,"maxLength":16},"scopes":{"type":"array","items":{"type":"string","enum":["rooms.read","rooms.write","documents.read","documents.upload","documents.write","flows.read","flows.write","exhibits.read","exhibits.write","messaging.read","messaging.write","qa.read","qa.write","team.read","team.write","office.read","office.write","audit.read","billing.read","outlook.addin"],"description":"One API key scope."},"minItems":1},"createdBy":{"type":"string","format":"uuid","description":"Principal id of the creating firm admin; the key acts as this principal."},"createdAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"},"lastUsedAt":{"type":"string","nullable":true,"format":"date-time"},"revokedAt":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["active","expired","revoked"]},"roomIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":50,"description":"Data rooms the key is limited to (ADR-0067); empty means firm-wide."},"personal":{"type":"boolean","description":"A member created this key for themselves under Mijn koppelingen (ADR-0067 D4): read-only scopes, refused while the firm switch is off."},"allowedCidrs":{"type":"array","items":{"type":"string"},"maxItems":20,"description":"Networks the key may be used from (ADR-0067 D6); empty means any address."},"rateLimitPerMinute":{"type":"integer","nullable":true,"minimum":1,"maximum":1000,"description":"Requests per minute for this key; null means the platform default (300)."},"rotatedFrom":{"type":"string","nullable":true,"format":"uuid","description":"The key this one replaced by rotation (ADR-0067 D6), if any."}},"required":["id","name","prefix","scopes","createdBy","createdAt","expiresAt","lastUsedAt","revokedAt","status","roomIds","personal","allowedCidrs","rateLimitPerMinute","rotatedFrom"],"description":"One API key of the firm (never the secret)."},"secret":{"type":"string","pattern":"^ddr_[A-Za-z0-9_-]{84}$"}},"required":["key","secret"],"description":"The created key and its secret (once)."}}}},"400":{"description":"Invalid body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (guests, support, services and API keys never manage keys).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, or a key that is not yours).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/me/api-keys/{keyId}/rotate":{"post":{"operationId":"rotateMyApiKey","summary":"Rotate one of my personal API keys","description":"Every firm role (`api_key.manage_own`) while the firm allows member integrations; only a personal key the caller created. Same rotation rules as the admin variant, within the firm lifetime ceiling. Refusals: `MEMBER_INTEGRATIONS_DISABLED` (403), another member’s key 404.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"API key id."},"required":true,"description":"API key id.","name":"keyId","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"graceDays":{"type":"integer","minimum":0,"maximum":30,"description":"Days the old key stays valid (0-30, default 7)."}},"additionalProperties":false,"description":"Rotate an API key."}}}},"responses":{"201":{"description":"The new key and its secret (once).","content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"API key id."},"name":{"type":"string","minLength":1,"maxLength":80},"prefix":{"type":"string","minLength":4,"maxLength":16},"scopes":{"type":"array","items":{"type":"string","enum":["rooms.read","rooms.write","documents.read","documents.upload","documents.write","flows.read","flows.write","exhibits.read","exhibits.write","messaging.read","messaging.write","qa.read","qa.write","team.read","team.write","office.read","office.write","audit.read","billing.read","outlook.addin"],"description":"One API key scope."},"minItems":1},"createdBy":{"type":"string","format":"uuid","description":"Principal id of the creating firm admin; the key acts as this principal."},"createdAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"},"lastUsedAt":{"type":"string","nullable":true,"format":"date-time"},"revokedAt":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["active","expired","revoked"]},"roomIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":50,"description":"Data rooms the key is limited to (ADR-0067); empty means firm-wide."},"personal":{"type":"boolean","description":"A member created this key for themselves under Mijn koppelingen (ADR-0067 D4): read-only scopes, refused while the firm switch is off."},"allowedCidrs":{"type":"array","items":{"type":"string"},"maxItems":20,"description":"Networks the key may be used from (ADR-0067 D6); empty means any address."},"rateLimitPerMinute":{"type":"integer","nullable":true,"minimum":1,"maximum":1000,"description":"Requests per minute for this key; null means the platform default (300)."},"rotatedFrom":{"type":"string","nullable":true,"format":"uuid","description":"The key this one replaced by rotation (ADR-0067 D6), if any."}},"required":["id","name","prefix","scopes","createdBy","createdAt","expiresAt","lastUsedAt","revokedAt","status","roomIds","personal","allowedCidrs","rateLimitPerMinute","rotatedFrom"],"description":"One API key of the firm (never the secret)."},"secret":{"type":"string","pattern":"^ddr_[A-Za-z0-9_-]{84}$"}},"required":["key","secret"],"description":"The created key and its secret (once)."}}}},"400":{"description":"Invalid body.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (guests, support, services and API keys never manage keys).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, or a key that is not yours).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/api-keys/overview":{"get":{"operationId":"getApiKeyOverview","summary":"Integrations overview for firm admins and compliance","description":"Every key of the firm with its owner’s display name, rooms, networks, last use and the requests and refusals of the last 30 days (counted from the `api_key.used` / `api_key.refused` audit events). Firm admin and compliance (`api_key.read`). Not callable with an API key.","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"}],"responses":{"200":{"description":"The overview, newest key first.","content":{"application/json":{"schema":{"type":"object","properties":{"keys":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"API key id."},"name":{"type":"string","minLength":1,"maxLength":80},"prefix":{"type":"string","minLength":4,"maxLength":16},"scopes":{"type":"array","items":{"type":"string","enum":["rooms.read","rooms.write","documents.read","documents.upload","documents.write","flows.read","flows.write","exhibits.read","exhibits.write","messaging.read","messaging.write","qa.read","qa.write","team.read","team.write","office.read","office.write","audit.read","billing.read","outlook.addin"],"description":"One API key scope."},"minItems":1},"createdBy":{"type":"string","format":"uuid","description":"Principal id of the creating firm admin; the key acts as this principal."},"createdAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"},"lastUsedAt":{"type":"string","nullable":true,"format":"date-time"},"revokedAt":{"type":"string","nullable":true,"format":"date-time"},"status":{"type":"string","enum":["active","expired","revoked"]},"roomIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":50,"description":"Data rooms the key is limited to (ADR-0067); empty means firm-wide."},"personal":{"type":"boolean","description":"A member created this key for themselves under Mijn koppelingen (ADR-0067 D4): read-only scopes, refused while the firm switch is off."},"allowedCidrs":{"type":"array","items":{"type":"string"},"maxItems":20,"description":"Networks the key may be used from (ADR-0067 D6); empty means any address."},"rateLimitPerMinute":{"type":"integer","nullable":true,"minimum":1,"maximum":1000,"description":"Requests per minute for this key; null means the platform default (300)."},"rotatedFrom":{"type":"string","nullable":true,"format":"uuid","description":"The key this one replaced by rotation (ADR-0067 D6), if any."},"creatorName":{"type":"string","nullable":true,"description":"Display name of the member the key acts as; null when unknown."},"uses30d":{"type":"integer","minimum":0,"description":"Authenticated requests in the last 30 days (from `api_key.used`)."},"refusals30d":{"type":"integer","minimum":0,"description":"Refused requests in the last 30 days (from `api_key.refused`)."}},"required":["id","name","prefix","scopes","createdBy","createdAt","expiresAt","lastUsedAt","revokedAt","status","roomIds","personal","allowedCidrs","rateLimitPerMinute","rotatedFrom","creatorName","uses30d","refusals30d"],"description":"One key in the integrations overview."},"description":"Every key of the firm, newest first."},"truncated":{"type":"boolean","description":"True when more keys exist than were returned."},"windowDays":{"type":"number","enum":[30],"description":"The usage window in days."}},"required":["keys","truncated","windowDays"],"description":"The integrations overview for firm admins and compliance."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (guests, support, services and API keys never manage keys).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, or a key that is not yours).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}},"/api/v1/t/{tenantId}/rooms/{roomId}/integration-activity":{"get":{"operationId":"listRoomIntegrationActivity","summary":"Integrations and AI assistants that accessed this room","description":"Owner decision B7 (ADR-0067 D6): every room member, guests included, sees which integrations or personal AI assistants of the firm made requests in this room, with counts and first and last time. Ids and counts only: never content, never a person’s name, never a secret (`room.read`).","parameters":[{"schema":{"type":"string","format":"uuid","description":"Tenant that owns the resource."},"required":true,"description":"Tenant that owns the resource.","name":"tenantId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Room id."},"required":true,"description":"Room id.","name":"roomId","in":"path"}],"responses":{"200":{"description":"The keys that read here, most recent first.","content":{"application/json":{"schema":{"type":"object","properties":{"entries":{"type":"array","items":{"type":"object","properties":{"apiKeyId":{"type":"string","format":"uuid","description":"The key that read here (an id, never a name or secret)."},"personal":{"type":"boolean","description":"A firm member’s personal assistant or integration (true) or a firm integration (false)."},"reads":{"type":"integer","minimum":0,"description":"Requests the key made in this room."},"firstAt":{"type":"string","format":"date-time"},"lastAt":{"type":"string","format":"date-time"}},"required":["apiKeyId","personal","reads","firstAt","lastAt"]},"maxItems":200}},"required":["entries"],"description":"Integrations and AI assistants that accessed this room."}}}},"401":{"description":"Signed out.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"403":{"description":"Forbidden (guests, support, services and API keys never manage keys).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}},"404":{"description":"Not found (including cross-tenant, or a key that is not yours).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHENTICATED","REAUTHENTICATION_REQUIRED","STEP_UP_REQUIRED","BAD_REQUEST","NOT_FOUND","FORBIDDEN","ACCOUNT_REQUIRED","READ_ONLY","CONFLICT","PACK_UNAVAILABLE","TEMPLATE_UNAVAILABLE","RATE_LIMITED","INTERNAL","PAGE_RENDERING","SOURCE_UNAVAILABLE","PROCESSING_NOT_FAILED","REVISION_CONFLICT","DOCUMENT_NOT_READY","DOCUMENT_NOT_FOUND","PROCEDURE_NOT_FOUND","EXHIBIT_SUBMITTED","EXHIBIT_NOT_SUBMITTED","SHORT_NAME_EMPTY","SHORT_NAME_TOO_LONG","SHORT_NAME_NOT_UNIQUE","NUMBER_OUT_OF_RANGE","ORDER_NOT_PERMUTATION","SEQUENCE_NOT_ALLOWED","SUBMIT_ORDER_VIOLATION","BUNDLE_STALE","BUNDLE_EXPIRED","BUNDLE_ERRORS_NOT_ACKNOWLEDGED","ROOM_TYPE_NOT_LITIGATION","INTERNAL_SOURCE_NOT_CONFIRMED","REOPEN_NOT_ALLOWED","PARTY_MISMATCH","PARTY_NOT_EMPTY","PROCEDURAL_DOCUMENT_NOT_EMPTY","PROCEDURAL_DOCUMENT_SUBMITTED","RENDITION_NOT_FAILED","FILING_PROMOTION_PENDING","TERMS_NOT_ACCEPTED","LEGAL_HOLD","RETENTION_EXPIRED","ITEM_NODE_IN_USE","RETENTION_BELOW_MINIMUM","REASON_NOT_ALLOWED","HOLD_ACTIVE","ROOM_DESTROYING","LAST_FIRM_ADMIN","INVALID_SETTINGS","INVITATION_EXPIRED","INVITATION_ALREADY_ACCEPTED","INVITATION_REVOKED","INVITATION_NOT_PENDING","INVITATION_EMAIL_MISMATCH","IDENTITY_SHARED","STORAGE_POOL_EXHAUSTED","EMAIL_CODE_REQUIRED","FLOW_NOT_DRAFT","ITEM_NOT_OPEN","ITEM_NOT_SUBMITTED","NOTHING_TO_SUBMIT","ROOM_NOT_CLOSED","RETENTION_UNSET","RETENTION_NOT_EXPIRED","OPEN_PROCEDURES","APPROVER_IS_REQUESTER","APPROVER_TENURE","APPROVAL_REQUIRED","PLAN_CHANGED","REQUEST_NOT_PENDING","REQUEST_EXPIRED","DOWNLOAD_MODE_RESTRICTED","PDF_UNAVAILABLE","NOTHING_TO_DOWNLOAD","SELECTION_TOO_LARGE","DOWNLOAD_NOT_READY","DOWNLOAD_EXPIRED","AUDIT_UNAVAILABLE","ARCHIVE_TOO_LARGE","NOTHING_TO_ARCHIVE","IP_NOT_ALLOWED","QUOTA_EXCEEDED","IMPORT_FILE_INVALID","IMPORT_TEMPLATE_MISMATCH","IMPORT_TOO_LARGE","IMPORT_EMPTY","IMPORT_ROWS_INVALID","ROOM_NOT_ACTIVE","EXHIBIT_FILING_OPEN","NOT_IN_TRASH","PURGE_PENDING","LAYOUT_PENDING","LAST_MANAGER","SMS_BUDGET_EXCEEDED","MEDICAL_ZONE_REFUSED","MASK_PENDING","INSUFFICIENT_SCOPE","ROOM_OUT_OF_SCOPE","MEMBER_INTEGRATIONS_DISABLED","SCOPE_NOT_ALLOWED","KEY_LIMIT_REACHED","SIGNING_NOT_PENDING","SIGNING_NOT_YOUR_TURN","SIGNING_PROVIDER_UNAVAILABLE","INVALID_STAGE_TRANSITION","ANSWER_CONFLICT"],"description":"Machine-readable error code."},"message":{"type":"string"}},"required":["code","message"]}},"required":["error"],"description":"Error envelope for every API failure."}}}}}}}}}