{ "openapi": "3.1.0", "info": { "title": "People’s Court API", "version": "2.0.0", "summary": "File disputes, submit evidence, follow cases, and retrieve signed decisions.", "contact": { "name": "People’s Court integration onboarding", "url": "https://peoplescourt.ai/request-demo", "email": "contact@peoplescourt.ai" }, "description": "Use role-bound credentials and the current resource state to create cases, represent an authorized party, build an immutable record, receive a served decision, and perform separately authorized settlement operations. The platform_native governing-law value leaves substantive-law selection to the Tribunal under Rule 12.2; it is not a jurisdiction. Intake law assertions do not establish a valid bilateral choice. A service_hold can reflect unresolved AI disposition or a technical/procedural impediment without human merits review. Internal remedy discussions, research queries, and inspection work remain private; no new adjudication authority is exposed. New integrations use canonical /api/filings and /api/cases resources; /api/v2 paths retain their documented compatibility contracts. Follow https://peoplescourt.ai/docs/api/get-started for credentials, exact packet acceptance, filing confirmation, respondent Answer, multipart evidence and signed callbacks. Run npm run sandbox:partner -- --demo with Node.js 22 or later for an isolated synthetic end-to-end workflow." }, "x-local-sandbox": { "command": "npm run sandbox:partner", "demoCommand": "npm run sandbox:partner -- --demo", "documentation": "https://peoplescourt.ai/docs/api/get-started", "isolation": "temporary_local_process", "synthetic": true, "description": "Local loopback process with a temporary JSON store, mock models, ephemeral credentials and signing keys, and blocked outbound connections. No .env, database credentials or provider keys are inherited. The default command prints bootstrap JSON and serves until stopped; --demo runs and cleans up. POST /_sandbox/control requires the bootstrap controlToken and exists only in this local process. Controls advance_clock, inject_failure, drain_callbacks, complete_case and simulate_execution support deterministic integration exercises. Simulated execution receipts always have synthetic true and paymentConfirmed false, separate from canonical execution state. The hosted /api/sandbox/{partnerId}/cases route remains read-only samples." }, "servers": [ { "url": "https://peoplescourt.ai" } ], "tags": [ { "name": "Integration sandbox", "description": "Isolated read-only synthetic stage samples for approved test tenants.", "x-status": "partial" }, { "name": "Filing preparation", "description": "Prepare an immutable filing packet for review and acceptance.", "x-status": "partial" }, { "name": "Filing confirmations", "description": "Confirm the reviewed packet and open one case when its requirements are met.", "x-status": "partial" }, { "name": "Authorizations", "description": "Manage delegated authority and record acceptance of exact filing terms.", "x-status": "partial" }, { "name": "Cases and participation", "description": "Read case state, invite participants, and file an Answer.", "x-status": "partial" }, { "name": "Case record", "description": "Submit evidence, inspect disclosed material, and confirm the party record.", "x-status": "partial" }, { "name": "Party procedure", "description": "Make party requests and exchange procedural messages.", "x-status": "partial" }, { "name": "Decision and remedies", "description": "Read served decisions and file eligible appeals or post-award requests.", "x-status": "partial" }, { "name": "Evaluation", "description": "Accept and read a jointly authorized narrow evaluation.", "x-status": "partial" }, { "name": "Fees", "description": "Read authorized fee and checkout information.", "x-status": "partial" }, { "name": "Execution", "description": "Inspect and request separately authorized settlement operations.", "x-status": "partial" }, { "name": "Notifications", "description": "Recover caller-scoped case events with a resumable cursor.", "x-status": "partial" }, { "name": "Discovery", "description": "Read the current Rules and quote filing fees before opening a case.", "x-status": "live" }, { "name": "Cases and drafts", "description": "Immutable preparation and tenant-scoped case state.", "x-status": "live" }, { "name": "AP2 Resolution Bridge", "description": "Feature-gated AP2 evidence verification and bilateral resolution intake over existing case, Award, finality, and execution resources.", "x-status": "partial" }, { "name": "UCP Resolution Adapter", "description": "Feature-gated UCP Order verification and bilateral resolution intake over the same existing case, Award, finality, and execution resources.", "x-status": "partial" }, { "name": "Participants invitations and authority", "description": "Side memberships, confirmation, and respondent handoff.", "x-status": "live" }, { "name": "Claims answers and submissions", "description": "Pleadings and stage-bound party filings.", "x-status": "live" }, { "name": "Case termination", "description": "Claimant withdrawal before the Answer and independently confirmed termination after the Answer.", "x-status": "live" }, { "name": "Evidence and challenges", "description": "Exchange signed evidence exports, adopt verified candidates, and challenge revealed opposing evidence without automatic exclusion.", "x-status": "live" }, { "name": "Messages", "description": "Immutable non-merits procedural messages with evidence-system references.", "x-status": "live" }, { "name": "Record confirmation", "description": "Own-side restatement review and immutable final record confirmation.", "x-status": "live" }, { "name": "Narrow evaluations", "description": "Jointly authorized bounded questions over a confirmed two-sided record.", "x-status": "live" }, { "name": "Decisions and finality", "description": "Served Awards, artifacts, decision finality, and record manifests.", "x-status": "live" }, { "name": "Settlement", "description": "Digest-bound settlement registration, validation, execution receipts, and decision status.", "x-status": "live" }, { "name": "Webhooks", "description": "Durable at-least-once callbacks with self-service rotation, inspection, replay, and dead-letter operations.", "x-status": "live" }, { "name": "Account OAuth", "description": "Account-bound authorization, registered agent clients, standing authority and existing-case partner delegation.", "x-status": "live" }, { "name": "Compatibility alias", "description": "Existing v2 contracts remain supported. Each capability starts its own minimum 180-day migration window only after equivalent canonical availability and published guidance. No retirement date is configured by default.", "x-status": "live" } ], "paths": { "/api/webhooks/endpoints": { "post": { "security": [ { "platformOrchestratorBearer": [] } ], "tags": [ "Webhooks" ], "operationId": "createOrRotateWebhookEndpoint", "summary": "Register or rotate the partner callback endpoint", "description": "Resolves and validates a public HTTPS destination before registration. Private, loopback, link-local, metadata, failed-DNS, and mixed-address targets are rejected; delivery revalidates and pins DNS. Canonical API flag required. Requires callbacks:manage and the platform orchestrator role; all results are tenant scoped.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerWebhookEndpointInput" } } } }, "responses": { "201": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalCreateOrRotateWebhookEndpointResponse" } } } }, "default": { "$ref": "#/components/responses/Problem" } } }, "get": { "security": [ { "platformOrchestratorBearer": [] } ], "tags": [ "Webhooks" ], "operationId": "listWebhookEndpoints", "summary": "List registered partner callback endpoints", "responses": { "200": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalListWebhookEndpointsResponse" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "description": "List registered partner callback endpoints. Requires callbacks:manage and the platform orchestrator role; all results are tenant scoped." } }, "/api/webhooks/deliveries": { "get": { "security": [ { "platformOrchestratorBearer": [] } ], "tags": [ "Webhooks" ], "operationId": "listWebhookDeliveries", "summary": "List tenant-scoped webhook deliveries", "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "pending", "sending", "delivered", "failed", "suppressed", "dead_letter" ] } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 100 } } ], "responses": { "200": { "description": "Tenant-scoped delivery history.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "required": [ "schemaVersion", "deliveries" ], "properties": { "schemaVersion": { "type": "string", "const": "partner-webhook-delivery-list-v2" }, "deliveries": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerWebhookDelivery" } } } }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "description": "List tenant-scoped webhook deliveries. Requires callbacks:manage and the platform orchestrator role; all results are tenant scoped." } }, "/api/webhooks/deliveries/{id}": { "get": { "security": [ { "platformOrchestratorBearer": [] } ], "tags": [ "Webhooks" ], "operationId": "getWebhookDelivery", "summary": "Read one webhook delivery and its attempts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delivery and immutable attempt history.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/PartnerWebhookDelivery" }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "description": "Read one webhook delivery and its attempts. Requires callbacks:manage and the platform orchestrator role; all results are tenant scoped." } }, "/api/webhooks/deliveries/{id}/replay": { "post": { "security": [ { "platformOrchestratorBearer": [] } ], "tags": [ "Webhooks" ], "operationId": "replayWebhookDelivery", "summary": "Append an operator-requested delivery for an existing logical event", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false } } } }, "responses": { "201": { "description": "New delivery for the existing logical event.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/PartnerWebhookDelivery" }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "description": "Replay an existing logical event as a new delivery. Requires callbacks:manage and the platform orchestrator role; all results are tenant scoped." } }, "/api/webhooks/endpoints/{id}": { "get": { "operationId": "getWebhookEndpoint", "tags": [ "Webhooks" ], "summary": "Read a tenant-scoped webhook endpoint", "description": "Canonical API flag required. Requires callbacks:manage and the platform orchestrator role. Endpoint URLs are immutable; use POST to rotate. DELETE is an idempotent soft disable. PATCH cannot activate an endpoint while another endpoint is active.", "security": [ { "platformOrchestratorBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalGetWebhookEndpointResponse" } } } }, "default": { "$ref": "#/components/responses/Problem" } } }, "patch": { "operationId": "updateWebhookEndpoint", "tags": [ "Webhooks" ], "summary": "Enable or disable a webhook endpoint", "description": "Canonical API flag required. Requires callbacks:manage and the platform orchestrator role. Endpoint URLs are immutable; use POST to rotate. DELETE is an idempotent soft disable. PATCH cannot activate an endpoint while another endpoint is active.", "security": [ { "platformOrchestratorBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalUpdateWebhookEndpointResponse" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "active", "disabled" ] } } } } } } }, "delete": { "operationId": "deleteWebhookEndpoint", "tags": [ "Webhooks" ], "summary": "Disable a webhook endpoint and retain delivery history", "description": "Canonical API flag required. Requires callbacks:manage and the platform orchestrator role. Endpoint URLs are immutable; use POST to rotate. DELETE is an idempotent soft disable. PATCH cannot activate an endpoint while another endpoint is active.", "security": [ { "platformOrchestratorBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalDeleteWebhookEndpointResponse" } } } }, "default": { "$ref": "#/components/responses/Problem" } } } }, "/api/cases/{id}/participants": { "get": { "security": [ { "platformOrchestratorBearer": [] }, { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] }, { "CanonicalSession": [] }, { "AccountOAuth": [ "cases:read" ] } ], "tags": [ "Cases and participation", "Participants invitations and authority" ], "operationId": "getCaseParticipantsCanonical", "summary": "List confirmed case participants and authority", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/PartyToken" } ], "responses": { "200": { "description": "Confirmed participants and their explicitly granted case operations.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "schemaVersion": { "const": "case-participants-v2" }, "caseId": { "type": "string" }, "participants": { "type": "array", "items": { "type": "object", "properties": { "participantId": { "type": "string" }, "side": { "type": "string", "enum": [ "claimant", "respondent" ] }, "name": { "type": "string" }, "status": { "type": "string" }, "principalId": { "type": "string" }, "partnerId": { "type": "string" }, "agentId": { "type": "string" }, "allowedOperations": { "type": "array", "items": { "$ref": "#/components/schemas/CaseMembershipOperationV2" } } } } } } }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "description": "List confirmed case participants and authority\n\nCanonical resource. Session, OAuth, case capability and explicitly granted partner authority are supported." } }, "/api/cases/{id}/evidence/{evidenceId}/authenticity-challenges": { "get": { "security": [ { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] }, { "CanonicalSession": [] }, { "AccountOAuth": [ "cases:read" ] } ], "tags": [ "Case record" ], "operationId": "getAuthenticityChallengesCanonical", "summary": "List all party-visible challenges for an evidence item", "description": "Requires evidence:challenges:read plus active tenant case membership and side binding. Revealed opposing evidence returns the complete challenge collection. Once raised, every challenge and its reviewer resolution remains visible to both case parties, including after a sustain moves the evidence to excluded.\n\nCanonical resource. Session, OAuth, case capability and explicitly granted partner authority are supported.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "evidenceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/PartyToken" } ], "responses": { "200": { "description": "Every visible challenge and reviewer resolution status.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/PartnerAuthenticityChallengeList" }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } } }, "post": { "security": [ { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] }, { "CanonicalSession": [] }, { "AccountOAuth": [ "submissions:write" ] } ], "tags": [ "Case record" ], "operationId": "raiseAuthenticityChallengeCanonical", "summary": "Challenge revealed opposing evidence", "description": "Requires evidence:challenges:write, Idempotency-Key, active tenant case membership, and the credential-bound side. The sanitized challenge is audit logged and docketed. Raising it contests weight only and never excludes evidence. Current Rules assign authenticity, admissibility, reliability, and weight to the AI Tribunal; historical cases retain their pinned assigned reviewer. A challenge may alternatively be embedded in a sealed rebuttal as challenges[]. Those entries are validated when filed and committed only at joint reveal, so they do not leak before the rebuttal opens.\n\nCanonical resource. Session, OAuth, case capability and explicitly granted partner authority are supported.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "evidenceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/PartyToken" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerAuthenticityChallengeInput" } } } }, "responses": { "200": { "description": "An already-open semantic challenge was returned without another write.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/PartnerAuthenticityChallenge" }, "requestId": { "type": "string" } } } } } }, "201": { "description": "Challenge newly raised, or the canonical replay of that creation response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/PartnerAuthenticityChallenge" }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } } } }, "/api/filings": { "post": { "security": [ { "platformOrchestratorBearer": [] }, { "claimantAgentBearer": [] }, { "AccountOAuth": [ "filings:write" ] } ], "x-account-branch": { "operationId": "prepareAccountFiling", "summary": "Prepare an account-owned filing and its hosted acceptance link", "description": "Account branch, selected by a People's Court account access token with filings:write. It creates an immutable account-owned standard-procedure draft and its review packet through the shared filing preparation service, resolving the claimant from the authenticated account. No partner tenant, partner credential, consent artifact or representative appointment is created. Typed requested relief, exact minor-unit money, pinned Rules and disclosure, fee prerequisites and the deferred respondent consent rule are preserved. The response carries the packet summary and a hosted acceptance link whose one-use secret is returned once and never stored in the idempotency replay body. Idempotency is the caller's key scoped to the authenticated account, not to a token: the same key with the same body replays the stored draft, and the same key with a different body is refused with idempotency_conflict. The partner branch is unchanged.", "tags": [ "Filing preparation" ], "security": [ { "AccountOAuth": [ "filings:write" ] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountFiling" } } } }, "responses": { "201": { "description": "The account-owned filing draft, its review packet and the one-use hosted acceptance link.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/AccountPreparedFiling" }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } } }, "tags": [ "Filing preparation" ], "operationId": "prepareFilingPreview", "summary": "Prepare a filing", "description": "Canonical intake vocabulary. Agent-only requires two registered autonomous-agent account IDs and each account’s exact case-specific OAuth acceptance before opening. External principal IDs remain delegation references, never account credentials. Internal names are rejected. Historical v2 drafts remain readable without rewriting. Schedule is separate from finality. Agent-only preparation currently requires direct fees; fee referrals are rejected. The x-pc-compatibility: v1 contract remains unchanged.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "x-pc-compatibility", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "v1" ] }, "description": "Bounded compatibility inputs on the canonical URL. Existing scoped credentials retain v1 responses; role-bound credentials use grant-checked typed operations. Preserves each contract’s original journals, consent and disclosure. See /openapi/partner-v1.json for scoped credentials." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalFiling" } } } }, "responses": { "201": { "description": "Canonical filing preparation state", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/CanonicalPreparedFiling" }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-contract": "v1" } }, "/api/filings/{id}": { "get": { "security": [ { "platformOrchestratorBearer": [] }, { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] }, { "AccountOAuth": [ "filings:write" ] } ], "x-account-branch": { "operationId": "getAccountFiling", "summary": "Read your own account-owned filing packet", "description": "Account branch, selected by a People's Court account access token with filings:write — the same authority that prepared the draft. Ownership is enforced before anything is read, and a draft owned by another account is not found. A prepared packet is rebuilt from the draft's own fields, so a moved Rules version, disclosure or published price refuses with filing_packet_changed rather than serving a stale packet; a confirmed draft keeps the packet its case was opened on and names that case. The one-use hosted acceptance link is a capability and is never re-served here: it is returned once by preparation, and a lost link is replaced by confirming with rotateAcceptanceLink.", "tags": [ "Filing preparation" ], "security": [ { "AccountOAuth": [ "filings:write" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The account-owned filing draft and its review packet, without any acceptance link.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/AccountPreparedFiling" }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } } }, "tags": [ "Filing preparation" ], "operationId": "getFilingPreview", "summary": "Read a case draft and its confirmation state", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Canonical filing preparation state", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/CanonicalPreparedFiling" }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "description": "Flag-gated canonical alias over the existing operation, with the same authorization, persistence and retry identity. " } }, "/api/filings/{id}/confirmations": { "post": { "security": [ { "platformOrchestratorBearer": [] }, { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] }, { "AccountOAuth": [ "filings:write" ] } ], "x-account-branch": { "operationId": "confirmAccountFiling", "summary": "Open the case this account already accepted on People's Court", "description": "Account branch, selected by a People's Court account access token with filings:write. The only inputs are the draft id in the path and the caller's idempotency key. In one guarded operation the server resolves the draft's owner (which must be the token principal), the recorded hosted_clickwrap acceptance by that principal for the draft's current digest, the applicable fee state, the current OAuth authority and the connector enablement policy, then invokes the shared case opening operation with commit-authorization proofs for the user, the OAuth token and grant, the authorizing client and the filing packet. The server consumes the recorded acceptance and never synthesizes one from arguments; no terms digest, acceptance statement, confirmation reference or principal is accepted here. Authentication and ownership precede replay lookup. A modified or expired packet returns acceptance_required and no persisted effect. That refusal is expected while the person is still reviewing, so it does not invalidate the page they already have open: it returns the packet and the issued link's acceptanceLinkExpiresAt, and carries a hostedAcceptanceUrl only when the issued link can no longer be used or when the request asked for a replacement. A payable filing fee returns filing_fee_required and opens nothing, because this branch initiates no payment. A response lost after commit is recoverable without opening a second case, including under a new idempotency key and after a token refresh. The partner branch is unchanged.", "tags": [ "Filing confirmations" ], "security": [ { "AccountOAuth": [ "filings:write" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "description": "The confirmation carries no acceptance argument. No terms digest, acceptance statement, confirmation reference or principal is accepted; the acceptance is the one already recorded on People's Court.", "properties": { "rotateAcceptanceLink": { "type": "boolean", "description": "Replace the one-use hosted acceptance link on an acceptance_required refusal. Ask for this only when the person reports a lost link; the previous link stops working." } } } } } }, "responses": { "201": { "description": "The case opened from this accepted packet, or the same case on a replay.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/AccountOpenedCase" }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } } }, "tags": [ "Filing confirmations" ], "operationId": "confirmFilingPreview", "summary": "Confirm one participant in a case draft", "description": "Flag-gated canonical alias over the existing operation, with the same authorization, persistence and retry identity. Records one participant confirmation. The last required confirmation atomically opens the case.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "x-pc-compatibility", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "v1" ] }, "description": "Bounded compatibility inputs on the canonical URL. Existing scoped credentials retain v1 responses; role-bound credentials use grant-checked typed operations. Preserves each contract’s original journals, consent and disclosure. See /openapi/partner-v1.json for scoped credentials." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDraftConfirmation" } } } }, "responses": { "201": { "description": "The case opened. Initial capabilities are returned once and are omitted from idempotency replays.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmedCaseDraftEnvelope" } } } }, "202": { "description": "The confirmation was recorded, but another required participant confirmation is still pending.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDraftResourceEnvelope" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-contract": "v1" } }, "/api/cases/{id}/submissions": { "post": { "security": [ { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] }, { "CanonicalSession": [] }, { "AccountOAuth": [ "submissions:write" ] } ], "tags": [ "Case record" ], "operationId": "fileSubmissionPreview", "summary": "Submit a stage-bound party brief and evidence", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Required for bearer requests. Hosted submission behavior is unchanged.", "schema": { "type": "string" } }, { "name": "x-pc-party", "in": "header", "required": false, "description": "Required for bearer credentials.", "schema": { "type": "string", "enum": [ "claimant", "respondent" ] } }, { "$ref": "#/components/parameters/PartyToken" }, { "name": "x-pc-compatibility", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "v1" ] }, "description": "Bounded compatibility inputs on the canonical URL. Existing scoped credentials retain v1 responses; role-bound credentials use grant-checked typed operations. Preserves each contract’s original journals, consent and disclosure. See /openapi/partner-v1.json for scoped credentials." } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CanonicalSubmissionForm" } } } }, "responses": { "201": { "description": "Committed party submission.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalFileSubmissionPreviewResponse" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "description": "Flag-gated canonical alias over the existing operation, with the same authorization, persistence and retry identity. Session requests use the existing hosted declaration fields; bearer requests use protocol certification and require x-pc-party plus Idempotency-Key. Hosted submission retries retain the existing stage/revision checks and do not acquire a new durable keyed replay journal.", "x-compatibility-contract": "v1" }, "get": { "operationId": "listSubmissionsPreview", "tags": [ "Case record" ], "summary": "Read disclosed filings and evidence", "description": "Controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. The shared operation rechecks current authority and pinned Rules. A party sees its own filings and jointly disclosed opponent material only.", "security": [ { "CanonicalSession": [] }, { "CanonicalPartnerBearer": [] }, { "AccountOAuth": [ "cases:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalListSubmissionsPreviewResponse" } } } }, "404": { "description": "Preview disabled or authorized resource unavailable." }, "default": { "$ref": "#/components/responses/Problem" } }, "x-preview": true } }, "/api/cases/{id}/events": { "get": { "security": [ { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] }, { "AccountOAuth": [ "cases:read" ] } ], "tags": [ "Notifications" ], "operationId": "getCaseEventsPreview", "summary": "Poll committed, caller-scoped case events", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/PartyToken" }, { "name": "x-pc-compatibility", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "v1" ] }, "description": "Bounded compatibility inputs on the canonical URL. Existing scoped credentials retain v1 responses; role-bound credentials use grant-checked typed operations. Preserves each contract’s original journals, consent and disclosure. See /openapi/partner-v1.json for scoped credentials." }, { "name": "after", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "responses": { "200": { "description": "Caller-visible committed events", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/CanonicalCaseEventPage" }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "description": "Durable audit-derived event IDs and opaque cursors. Resume with after; default limit 50, maximum 100. Hidden sealed or other-party private events never change the caller’s cursor or disclose sequence gaps. Invalid, cross-case or undisclosed cursors return 422. The x-pc-compatibility: v1 docket snapshot is unchanged. Webhook caseEvent.id and caseEvent.cursor reconcile to this stream; delivery eventId and sequence retain their existing deduplication meaning.", "x-compatibility-contract": "v1" } }, "/api/cases/{id}/evidence": { "get": { "operationId": "listCaseEvidencePreview", "tags": [ "Case record" ], "summary": "List the caller's authorized evidence for a case", "description": "Controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. The shared operation rechecks current authority and pinned Rules. Returns the caller's own exhibits plus opposing exhibits that disclosure has already revealed; simultaneous exchange is unchanged and sanitization internals are never projected. A partner bearer credential also receives the adoption candidates for its own membership side, the same listing the evidence-candidates alias returns. Download one original file with /api/cases/{id}/evidence/{evidenceId}.", "security": [ { "CanonicalSession": [] }, { "CanonicalPartnerBearer": [] }, { "AccountOAuth": [ "cases:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/PartyToken" } ], "responses": { "200": { "description": "Caller-scoped evidence collection.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/CanonicalCaseEvidenceCollection" }, "requestId": { "type": "string" } } } } } }, "404": { "description": "Preview disabled or authorized resource unavailable." }, "default": { "$ref": "#/components/responses/Problem" } }, "x-preview": true } }, "/api/cases/{id}/evidence-processing": { "get": { "operationId": "getEvidenceProcessingPreview", "tags": [ "Case record" ], "summary": "Review disclosed source processing for the authorized party", "description": "Controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. The shared operation rechecks current authority and pinned Rules. Party-scoped processing projection; successful durable reports require PostgreSQL.", "security": [ { "CanonicalSession": [] }, { "CanonicalPartnerBearer": [] }, { "AccountOAuth": [ "cases:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalGetEvidenceProcessingPreviewResponse" } } } }, "404": { "description": "Preview disabled or authorized resource unavailable." }, "default": { "$ref": "#/components/responses/Problem" } } } }, "/api/cases/{id}/evidence-processing/{sourceId}/defects": { "post": { "operationId": "reportProcessingDefectPreview", "tags": [ "Case record" ], "summary": "Report a defect against the exact displayed derivative", "description": "Controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. The shared operation rechecks current authority and pinned Rules. Partner reports require defects:report and bind the exact derivative shown to the reporting party. Resolution stays internal.", "security": [ { "CanonicalSession": [] }, { "CanonicalPartnerBearer": [] }, { "AccountOAuth": [ "submissions:write" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Reuse across compatibility and canonical aliases to recover the same committed act. Changed typed input conflicts." } ], "responses": { "201": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalReportProcessingDefectPreviewResponse" } } } }, "404": { "description": "Preview disabled or authorized resource unavailable." }, "default": { "$ref": "#/components/responses/Problem" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessingDefectPreview" } } } } } }, "/api/cases/{id}/appeals": { "post": { "operationId": "fileAppealPreview", "tags": [ "Decision and remedies" ], "summary": "File an authorized appeal", "description": "Flag-gated preview over the shared remedy operations. Session/case proofs retain existing scope. Partner writes require an explicit appeal:file, appeal:answer, or post_award:request membership grant; existing memberships are not widened. Idempotency-Key shares durable receipts with hosted aliases. Only internal actors decide remedies or confirm provider payment. POST post-award-requests accepts action=respond with requestId and response for the opposite party’s response.", "security": [ { "CanonicalPartnerBearer": [] }, { "CanonicalSession": [] }, { "AccountOAuth": [ "remedies:write" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalRemedyInput" } } } }, "responses": { "200": { "description": "Authorized read, response, or recovered result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalFileAppealPreviewResponse" } } } }, "201": { "description": "Remedy act recorded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalFileAppealPreviewResponse" } } } }, "404": { "description": "Preview disabled or authorized resource unavailable." }, "default": { "description": "Stable problem code and requestId.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "get": { "operationId": "getAppealsPreview", "tags": [ "Decision and remedies" ], "summary": "Read the authorized appeal and reservation", "description": "Flag-gated preview over the shared remedy operations. Session/case proofs retain existing scope. Partner writes require an explicit appeal:file, appeal:answer, or post_award:request membership grant; existing memberships are not widened. Idempotency-Key shares durable receipts with hosted aliases. Only internal actors decide remedies or confirm provider payment. POST post-award-requests accepts action=respond with requestId and response for the opposite party’s response.", "security": [ { "CanonicalPartnerBearer": [] }, { "CanonicalSession": [] }, { "AccountOAuth": [ "cases:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authorized read, response, or recovered result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalGetAppealsPreviewResponse" } } } }, "201": { "description": "Remedy act recorded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalGetAppealsPreviewResponse" } } } }, "404": { "description": "Preview disabled or authorized resource unavailable." }, "default": { "description": "Stable problem code and requestId.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/cases/{id}/appeals/{appealId}/answers": { "post": { "operationId": "answerAppealPreview", "tags": [ "Decision and remedies" ], "summary": "File the opposite party’s answering brief", "description": "Flag-gated preview over the shared remedy operations. Session/case proofs retain existing scope. Partner writes require an explicit appeal:file, appeal:answer, or post_award:request membership grant; existing memberships are not widened. Idempotency-Key shares durable receipts with hosted aliases. Only internal actors decide remedies or confirm provider payment. POST post-award-requests accepts action=respond with requestId and response for the opposite party’s response.", "security": [ { "CanonicalPartnerBearer": [] }, { "CanonicalSession": [] }, { "AccountOAuth": [ "remedies:write" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appealId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalRemedyInput" } } } }, "responses": { "200": { "description": "Authorized read, response, or recovered result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalAnswerAppealPreviewResponse" } } } }, "201": { "description": "Remedy act recorded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalAnswerAppealPreviewResponse" } } } }, "404": { "description": "Preview disabled or authorized resource unavailable." }, "default": { "description": "Stable problem code and requestId.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/cases/{id}/appeals/{appealId}/fee": { "get": { "operationId": "getAppealFeePreview", "tags": [ "Decision and remedies" ], "summary": "Read the linked appeal fee status", "description": "Flag-gated preview over the shared remedy operations. Session/case proofs retain existing scope. Partner writes require an explicit appeal:file, appeal:answer, or post_award:request membership grant; existing memberships are not widened. Idempotency-Key shares durable receipts with hosted aliases. Only internal actors decide remedies or confirm provider payment. POST post-award-requests accepts action=respond with requestId and response for the opposite party’s response.", "security": [ { "CanonicalPartnerBearer": [] }, { "CanonicalSession": [] }, { "AccountOAuth": [ "cases:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "appealId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authorized read, response, or recovered result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalGetAppealFeePreviewResponse" } } } }, "201": { "description": "Remedy act recorded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalGetAppealFeePreviewResponse" } } } }, "404": { "description": "Preview disabled or authorized resource unavailable." }, "default": { "description": "Stable problem code and requestId.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/cases/{id}/post-award-requests": { "post": { "operationId": "filePostAwardRequestPreview", "tags": [ "Decision and remedies" ], "summary": "File or respond to a post-award request", "description": "Flag-gated preview over the shared remedy operations. Session/case proofs retain existing scope. Partner writes require an explicit appeal:file, appeal:answer, or post_award:request membership grant; existing memberships are not widened. Idempotency-Key shares durable receipts with hosted aliases. Only internal actors decide remedies or confirm provider payment. POST post-award-requests accepts action=respond with requestId and response for the opposite party’s response.", "security": [ { "CanonicalPartnerBearer": [] }, { "CanonicalSession": [] }, { "AccountOAuth": [ "remedies:write" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalRemedyInput" } } } }, "responses": { "200": { "description": "Authorized read, response, or recovered result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalFilePostAwardRequestPreviewResponse" } } } }, "201": { "description": "Remedy act recorded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalFilePostAwardRequestPreviewResponse" } } } }, "404": { "description": "Preview disabled or authorized resource unavailable." }, "default": { "description": "Stable problem code and requestId.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "get": { "operationId": "listPostAwardRequestsPreview", "tags": [ "Decision and remedies" ], "summary": "Read post-award requests", "description": "Flag-gated preview over the shared remedy operations. Session/case proofs retain existing scope. Partner writes require an explicit appeal:file, appeal:answer, or post_award:request membership grant; existing memberships are not widened. Idempotency-Key shares durable receipts with hosted aliases. Only internal actors decide remedies or confirm provider payment. POST post-award-requests accepts action=respond with requestId and response for the opposite party’s response.", "security": [ { "CanonicalPartnerBearer": [] }, { "CanonicalSession": [] }, { "AccountOAuth": [ "cases:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authorized read, response, or recovered result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalListPostAwardRequestsPreviewResponse" } } } }, "201": { "description": "Remedy act recorded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalListPostAwardRequestsPreviewResponse" } } } }, "404": { "description": "Preview disabled or authorized resource unavailable." }, "default": { "description": "Stable problem code and requestId.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/cases/{id}": { "get": { "operationId": "getCasePreview", "tags": [ "Cases and participation" ], "summary": "Read an authorized case view", "description": "Preview controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. Accepts an authorized session or partner bearer; Answer also accepts the existing wallet/invitation proof. A record-summary correction is a distinct party act, so an active case membership must allow restatement:respond, which record:confirm alone never grants. Existing aliases and their application operations remain authoritative. Idempotency-Key reuses the alias journal.", "security": [ { "CanonicalPartnerBearer": [] }, { "CanonicalSession": [] }, { "AccountOAuth": [ "cases:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "x-pc-compatibility", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "v1" ] }, "description": "Bounded compatibility inputs on the canonical URL. Existing scoped credentials retain v1 responses; role-bound credentials use grant-checked typed operations. Preserves each contract’s original journals, consent and disclosure. See /openapi/partner-v1.json for scoped credentials." } ], "responses": { "200": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalCaseViewEnvelope" } } } }, "201": { "description": "Answer or invitation created through the shared partner operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalCaseViewEnvelope" } } } }, "404": { "description": "Preview disabled or resource unavailable." }, "default": { "description": "Stable problem code and requestId; no protected state disclosed.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-compatibility-contract": "v1" } }, "/api/cases/{id}/answer": { "post": { "operationId": "fileAnswerPreview", "tags": [ "Cases and participation" ], "summary": "Accept the pinned terms and file an Answer atomically", "description": "Preview controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. Accepts an authorized session or partner bearer; Answer also accepts the existing wallet/invitation proof. A record-summary correction is a distinct party act, so an active case membership must allow restatement:respond, which record:confirm alone never grants. Existing aliases and their application operations remain authoritative. Idempotency-Key reuses the alias journal.", "security": [ { "CanonicalPartnerBearer": [] }, { "CanonicalSession": [] }, { "AccountOAuth": [ "answers:write" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalAnswerInput" } } } }, "responses": { "200": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalFileAnswerPreviewResponse" } } } }, "201": { "description": "Answer or invitation created through the shared partner operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalFileAnswerPreviewResponse" } } } }, "404": { "description": "Preview disabled or resource unavailable." }, "default": { "description": "Stable problem code and requestId; no protected state disclosed.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/cases/{id}/record-summary": { "get": { "operationId": "getRecordSummaryPreview", "tags": [ "Case record" ], "summary": "Read the authenticated party record summary", "description": "Preview controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. Accepts an authorized session or partner bearer; Answer also accepts the existing wallet/invitation proof. A record-summary correction is a distinct party act, so an active case membership must allow restatement:respond, which record:confirm alone never grants. Existing aliases and their application operations remain authoritative. Idempotency-Key reuses the alias journal.", "security": [ { "CanonicalPartnerBearer": [] }, { "CanonicalSession": [] }, { "AccountOAuth": [ "cases:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalRecordSummaryEnvelope" } } } }, "201": { "description": "Answer or invitation created through the shared partner operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalRecordSummaryEnvelope" } } } }, "404": { "description": "Preview disabled or resource unavailable." }, "default": { "description": "Stable problem code and requestId; no protected state disclosed.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/cases/{id}/record-summary/corrections": { "post": { "operationId": "correctRecordSummaryPreview", "tags": [ "Case record" ], "summary": "Propose a party record correction", "description": "Preview controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. Accepts an authorized session or partner bearer; Answer also accepts the existing wallet/invitation proof. A record-summary correction is a distinct party act, so an active case membership must allow restatement:respond, which record:confirm alone never grants. Existing aliases and their application operations remain authoritative. Idempotency-Key reuses the alias journal.", "security": [ { "CanonicalPartnerBearer": [] }, { "CanonicalSession": [] }, { "AccountOAuth": [ "records:write" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalRecordCorrectionInput" } } } }, "responses": { "200": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalRecordCorrectionEnvelope" } } } }, "201": { "description": "Answer or invitation created through the shared partner operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalRecordCorrectionEnvelope" } } } }, "404": { "description": "Preview disabled or resource unavailable." }, "default": { "description": "Stable problem code and requestId; no protected state disclosed.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/cases/{id}/record-summary/confirmations": { "post": { "operationId": "confirmRecordSummaryPreview", "tags": [ "Case record" ], "summary": "Confirm the exact party record digest", "description": "Preview controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. Accepts an authorized session or partner bearer; Answer also accepts the existing wallet/invitation proof. A record-summary correction is a distinct party act, so an active case membership must allow restatement:respond, which record:confirm alone never grants. Existing aliases and their application operations remain authoritative. Idempotency-Key reuses the alias journal.", "security": [ { "CanonicalPartnerBearer": [] }, { "CanonicalSession": [] }, { "AccountOAuth": [ "records:confirm" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalRecordConfirmationInput" } } } }, "responses": { "200": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalRecordConfirmationEnvelope" } } } }, "201": { "description": "Answer or invitation created through the shared partner operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalRecordConfirmationEnvelope" } } } }, "404": { "description": "Preview disabled or resource unavailable." }, "default": { "description": "Stable problem code and requestId; no protected state disclosed.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/cases/{id}/invitations": { "post": { "operationId": "createInvitationPreview", "tags": [ "Cases and participation" ], "summary": "Create or rotate a respondent invitation", "description": "Preview controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. Accepts an authorized session or partner bearer; Answer also accepts the existing wallet/invitation proof. A record-summary correction is a distinct party act, so an active case membership must allow restatement:respond, which record:confirm alone never grants. Existing aliases and their application operations remain authoritative. Idempotency-Key reuses the alias journal.", "security": [ { "CanonicalPartnerBearer": [] }, { "CanonicalSession": [] }, { "AccountOAuth": [ "invitations:write" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalInvitationInput" } } } }, "responses": { "200": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalInvitationEnvelope" } } } }, "201": { "description": "Answer or invitation created through the shared partner operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalInvitationEnvelope" } } } }, "404": { "description": "Preview disabled or resource unavailable." }, "default": { "description": "Stable problem code and requestId; no protected state disclosed.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v2/integration": { "get": { "security": [ { "platformOrchestratorBearer": [] }, { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] }, { "evidenceExporterBearer": [] }, { "settlementAdapterBearer": [] }, { "readOnlyObserverBearer": [] } ], "tags": [ "Compatibility alias", "Discovery" ], "operationId": "getIntegrationIdentityV2", "summary": "Verify a credential and inspect its tenant role and capabilities", "responses": { "200": { "description": "Authenticated integration identity and public credential metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerIntegrationIdentityEnvelope" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "description": "Verify a credential and inspect its tenant role and capabilities\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/rules/current": { "get": { "security": [], "tags": [ "Compatibility alias", "Discovery" ], "operationId": "getCurrentRulesV2", "summary": "Read the current Rules and public procedure metadata", "responses": { "200": { "$ref": "#/components/responses/Data" }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "description": "Read the current Rules and public procedure metadata\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/fees/quote": { "post": { "security": [], "tags": [ "Compatibility alias", "Discovery" ], "operationId": "quoteFilingFeeV2", "summary": "Quote the filing fee for a proposed claim", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "claimAmount" ], "properties": { "claimAmount": { "$ref": "#/components/schemas/FiatMoney" }, "declaratoryOnly": { "type": "boolean" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/Data" }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "description": "Quote the filing fee for a proposed claim\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/ap2/resolution-requests": { "post": { "security": [ { "platformOrchestratorBearer": [] } ], "tags": [ "Compatibility alias", "AP2 Resolution Bridge" ], "operationId": "createAp2ResolutionRequestV1", "summary": "Verify an AP2 package and open an existing bilateral evaluation case", "description": "AP2 purchase authority is evidence only. A case opens only after the separate resolution-authorization-v1 artifact carries valid claimant and respondent signatures.\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ap2ResolutionRequestV1" } } } }, "responses": { "201": { "$ref": "#/components/responses/Ap2ResolutionCase" }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/ap2/resolution-results/{caseId}": { "get": { "security": [ { "platformOrchestratorBearer": [] }, { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] }, { "readOnlyObserverBearer": [] } ], "tags": [ "Compatibility alias", "AP2 Resolution Bridge" ], "operationId": "getAp2ResolutionResultV1", "summary": "Project the existing Award finality authorized remedy and execution confirmation", "parameters": [ { "$ref": "#/components/parameters/CaseId" } ], "responses": { "200": { "$ref": "#/components/responses/ResolutionResult" }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "description": "Project the existing Award finality authorized remedy and execution confirmation\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/ucp/resolution-requests": { "post": { "security": [ { "platformOrchestratorBearer": [] } ], "tags": [ "Compatibility alias", "UCP Resolution Adapter" ], "operationId": "createUcpResolutionRequestV1", "summary": "Verify a signed UCP Order and open an existing bilateral evaluation case", "description": "The UCP Order is transaction evidence only. A case opens only after the separate resolution-authorization-v1 artifact carries valid claimant and respondent signatures and exactly matches the neutral handoff.\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UcpResolutionRequestV1" } } } }, "responses": { "201": { "$ref": "#/components/responses/UcpResolutionCase" }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/ucp/resolution-results/{caseId}": { "get": { "security": [ { "platformOrchestratorBearer": [] }, { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] }, { "readOnlyObserverBearer": [] } ], "tags": [ "Compatibility alias", "UCP Resolution Adapter" ], "operationId": "getUcpResolutionResultV1", "summary": "Project the existing Award finality authorized remedy and execution confirmation", "parameters": [ { "$ref": "#/components/parameters/CaseId" } ], "responses": { "200": { "$ref": "#/components/responses/ResolutionResult" }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "description": "Project the existing Award finality authorized remedy and execution confirmation\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/filings/prepare": { "post": { "security": [ { "platformOrchestratorBearer": [] }, { "claimantAgentBearer": [] } ], "tags": [ "Compatibility alias", "Cases and drafts" ], "operationId": "prepareFilingV2", "summary": "Prepare a claimant filing draft", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrepareFiling" } } } }, "responses": { "201": { "description": "Prepared packet. Claimant acceptance is required before confirmation opens the case.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilingPacketPreparationEnvelope" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "description": "Prepare a claimant filing draft\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/filings/{draftId}/confirm": { "post": { "security": [ { "platformOrchestratorBearer": [] }, { "claimantAgentBearer": [] } ], "tags": [ "Compatibility alias", "Cases and drafts" ], "operationId": "confirmFilingV2", "summary": "Confirm and open a prepared claimant filing", "parameters": [ { "$ref": "#/components/parameters/DraftId" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilingConfirmation" } } } }, "responses": { "201": { "$ref": "#/components/responses/Data" }, "409": { "description": "Conflict, including acceptance_required. Hosted acceptance, explicit principal-bound API acceptance, or an exact wallet signature is required for new packets. Standing grants require step 11. Authorized claimant callers receive the packet digest and a new scoped hosted link.", "content": { "application/problem+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Problem" }, { "$ref": "#/components/schemas/FilingAcceptanceRequiredProblem" } ] } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "description": "Confirm and open a prepared claimant filing\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/case-drafts": { "post": { "security": [ { "platformOrchestratorBearer": [] }, { "claimantAgentBearer": [] } ], "tags": [ "Compatibility alias", "Cases and drafts" ], "operationId": "createCaseDraftV2", "summary": "Create a configurable case draft", "description": "Creates a case draft for the selected intake and confirmation policy. In claimant_initiated mode the claimant may omit respondent consent; the case opens awaiting a human respondent who accepts through the show-once hosted login path. Every other mode remains bilaterally authorized.\n\nCompatibility alias. Replacement: /api/filings. Identical draft body and data envelope; same draft identity and Idempotency-Key. Window: at least 180 days from equivalent canonical general availability and the published migration guide; dates are emitted only when the shared policy start is configured and canonical routes are enabled.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCaseDraft" } } } }, "responses": { "201": { "description": "Prepared packet. Claimant acceptance is required before confirmation opens the case.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilingPacketPreparationEnvelope" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "Replacement: /api/filings. Identical draft body and data envelope; same draft identity and Idempotency-Key. Window: at least 180 days from equivalent canonical general availability and the published migration guide; dates are emitted only when the shared policy start is configured and canonical routes are enabled." } }, "/api/v2/fee-referrals": { "post": { "security": [ { "platformOrchestratorBearer": [] } ], "tags": [ "Compatibility alias", "Cases and drafts" ], "operationId": "authorizePartnerFeeReferralV2", "summary": "Authorize one agreement-derived filing-fee referral", "description": "Requires fee_referrals:authorize on an explicitly provisioned platform_orchestrator. The server selects the active commercial account and immutable agreement version. The caller supplies referral identity and intended parties but cannot select a price, payer, billing cadence, account, or agreement. Authorization alone does not open a case.\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerFeeReferralInput" } } } }, "responses": { "200": { "description": "An identical partner fee referral already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerFeeReferralEnvelope" } } } }, "201": { "description": "Partner fee referral accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerFeeReferralEnvelope" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/fees/stripe/checkout": { "post": { "security": [ { "platformOrchestratorBearer": [] } ], "tags": [ "Compatibility alias", "Cases and drafts" ], "operationId": "createPartnerFilingCheckoutV2", "summary": "Create the Stripe Checkout session for a party-paid partner filing fee", "description": "Requires fee_referrals:authorize on the owning partner's explicitly provisioned platform_orchestrator credential. The server resolves the public case ID to exactly one payable party-due filing fee and does not accept an internal dispute ID or fee ID. Stripe session creation and the Partner API response are idempotent for that fee.\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerFilingCheckoutInput" } } } }, "responses": { "201": { "description": "Idempotent Stripe Checkout session for the exact partner filing fee.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerFilingCheckoutEnvelope" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/sponsorship-referrals": { "post": { "security": [ { "platformOrchestratorBearer": [] } ], "tags": [ "Compatibility alias", "Cases and drafts" ], "operationId": "authorizeCaseSponsorshipReferralV2", "summary": "Authorize one case-specific filing sponsorship referral", "description": "Requires the sponsorships:authorize capability on an explicitly provisioned platform_orchestrator credential. The server derives the sponsor, active agreement, $5 filing assessment, and environment; callers cannot select price or commercial terms. Authorization alone does not docket a case or accrue an obligation.\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseSponsorshipReferralInput" } } } }, "responses": { "200": { "description": "An identical coverage authorization already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseSponsorshipReferralEnvelope" } } } }, "201": { "description": "Case-specific referral accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseSponsorshipReferralEnvelope" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/authorizations/authority-grants": { "post": { "security": [ { "claimantAgentBearer": [] } ], "tags": [ "Compatibility alias", "Participants invitations and authority" ], "operationId": "registerClaimantAuthorityV2", "summary": "Record a claimant-agent authority assertion and artifact hashes", "description": "Records which authenticated claimant-agent credential made the assertion plus the supplied artifact references and hashes. This endpoint does not retrieve the artifacts or cryptographically verify an underlying principal signature. A platform-orchestrator credential cannot make the assertion.\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorityGrantRegistration" } } } }, "responses": { "201": { "description": "The authenticated claimant-agent assertion was recorded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorityGrantRegistrationEnvelope" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/authorizations/consents": { "post": { "security": [ { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Compatibility alias", "Participants invitations and authority" ], "operationId": "registerPartyConsentV2", "summary": "Record one party-agent consent assertion and artifact hash", "description": "Records which role-bound partner credential made the assertion and the supplied artifact reference and hash. The credential role must match the submitted party. This endpoint does not verify an underlying principal signature, email delivery, or artifact availability. Each side is a separate idempotent call.\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsentArtifactRegistration" } } } }, "responses": { "201": { "description": "The authenticated party-agent consent assertion was recorded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsentArtifactRegistrationEnvelope" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/case-drafts/{draftId}": { "get": { "security": [ { "platformOrchestratorBearer": [] }, { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Compatibility alias", "Cases and drafts" ], "operationId": "getCaseDraftV2", "summary": "Read a case draft and its confirmation state", "parameters": [ { "$ref": "#/components/parameters/DraftId" } ], "responses": { "200": { "$ref": "#/components/responses/Data" }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "Replacement: /api/filings/{id}. Same immutable packet and digest. Window: at least 180 days from equivalent canonical general availability and the published migration guide; dates are emitted only when the shared policy start is configured and canonical routes are enabled.", "description": "Read a case draft and its confirmation state\n\nCompatibility alias. Replacement: /api/filings/{id}. Same immutable packet and digest. Window: at least 180 days from equivalent canonical general availability and the published migration guide; dates are emitted only when the shared policy start is configured and canonical routes are enabled." } }, "/api/v2/case-drafts/{draftId}/confirmations": { "post": { "security": [ { "platformOrchestratorBearer": [] }, { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Compatibility alias", "Participants invitations and authority" ], "operationId": "confirmCaseDraftParticipantV2", "summary": "Confirm one participant in a case draft", "description": "Records one participant confirmation. The last required confirmation atomically opens the case.\n\nCompatibility alias. Replacement: /api/filings/{id}/confirmations. Same confirmations and opening journal; preserve the exact accepted digest. Window: at least 180 days from equivalent canonical general availability and the published migration guide; dates are emitted only when the shared policy start is configured and canonical routes are enabled.", "parameters": [ { "$ref": "#/components/parameters/DraftId" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDraftConfirmation" } } } }, "responses": { "201": { "description": "The case opened. Initial capabilities are returned once and are omitted from idempotency replays.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmedCaseDraftEnvelope" } } } }, "202": { "description": "The confirmation was recorded, but another required participant confirmation is still pending.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseDraftResourceEnvelope" } } } }, "409": { "description": "Conflict, including acceptance_required. Hosted acceptance, explicit principal-bound API acceptance, or an exact wallet signature is required for new packets. Standing grants require step 11. Authorized claimant callers receive the packet digest and a new scoped hosted link.", "content": { "application/problem+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/Problem" }, { "$ref": "#/components/schemas/FilingAcceptanceRequiredProblem" } ] } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "Replacement: /api/filings/{id}/confirmations. Same confirmations and opening journal; preserve the exact accepted digest. Window: at least 180 days from equivalent canonical general availability and the published migration guide; dates are emitted only when the shared policy start is configured and canonical routes are enabled." } }, "/api/v2/cases/{caseId}": { "get": { "security": [ { "platformOrchestratorBearer": [] }, { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] }, { "readOnlyObserverBearer": [] } ], "tags": [ "Compatibility alias", "Cases and drafts" ], "operationId": "getCaseV2", "summary": "Read the current case projection", "parameters": [ { "$ref": "#/components/parameters/CaseId" }, { "$ref": "#/components/parameters/PartyToken" } ], "responses": { "200": { "$ref": "#/components/responses/Data" }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "Replacement: /api/cases/{id}. Canonical authorized case view uses data/requestId and public vocabulary; preserve the existing case ID. Window: at least 180 days from equivalent canonical general availability and the published migration guide; dates are emitted only when the shared policy start is configured and canonical routes are enabled.", "description": "Read the current case projection\n\nCompatibility alias. Replacement: /api/cases/{id}. Canonical authorized case view uses data/requestId and public vocabulary; preserve the existing case ID. Window: at least 180 days from equivalent canonical general availability and the published migration guide; dates are emitted only when the shared policy start is configured and canonical routes are enabled." } }, "/api/v2/cases/{caseId}/respondent-handoff": { "post": { "security": [ { "platformOrchestratorBearer": [] } ], "tags": [ "Compatibility alias", "Participants invitations and authority" ], "operationId": "issueRespondentHandoffV2", "summary": "Issue a show-once respondent handoff", "parameters": [ { "$ref": "#/components/parameters/CaseId" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "responses": { "201": { "description": "Show-once respondent invite plus the exact EIP-191 consent message the respondent wallet must sign. The message binds this public caseId and contains no internal dispute identifier.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/RespondentHandoff" }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "Replacement: /api/cases/{id}/invitations. Preserve partner handoff body and show-once token semantics; same keyed rotation. Window: at least 180 days from equivalent canonical general availability and the published migration guide; dates are emitted only when the shared policy start is configured and canonical routes are enabled.", "description": "Issue a show-once respondent handoff\n\nCompatibility alias. Replacement: /api/cases/{id}/invitations. Preserve partner handoff body and show-once token semantics; same keyed rotation. Window: at least 180 days from equivalent canonical general availability and the published migration guide; dates are emitted only when the shared policy start is configured and canonical routes are enabled." } }, "/api/v2/cases/{caseId}/participants": { "get": { "security": [ { "platformOrchestratorBearer": [] }, { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Compatibility alias", "Participants invitations and authority" ], "operationId": "getCaseParticipantsV2", "summary": "List confirmed case participants and authority", "parameters": [ { "$ref": "#/components/parameters/CaseId" }, { "$ref": "#/components/parameters/PartyToken" } ], "responses": { "200": { "description": "Confirmed participants and their explicitly granted case operations.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "participants": { "type": "array", "items": { "type": "object", "properties": { "allowedOperations": { "type": "array", "items": { "$ref": "#/components/schemas/CaseMembershipOperationV2" } } } } } } } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "description": "List confirmed case participants and authority\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/cases/{caseId}/answer": { "post": { "security": [ { "respondentAgentBearer": [] } ], "tags": [ "Compatibility alias", "Claims answers and submissions" ], "operationId": "answerV2", "summary": "File the respondent Answer", "parameters": [ { "$ref": "#/components/parameters/CaseId" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Answer" } } } }, "responses": { "201": { "$ref": "#/components/responses/Data" }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "Replacement: /api/cases/{id}/answer. Typed Answer relief and existing authority remain; canonical data/problem envelope and shared logical identity. Window: at least 180 days from equivalent canonical general availability and the published migration guide; dates are emitted only when the shared policy start is configured and canonical routes are enabled.", "description": "File the respondent Answer\n\nCompatibility alias. Replacement: /api/cases/{id}/answer. Typed Answer relief and existing authority remain; canonical data/problem envelope and shared logical identity. Window: at least 180 days from equivalent canonical general availability and the published migration guide; dates are emitted only when the shared policy start is configured and canonical routes are enabled." } }, "/api/v2/cases/{caseId}/termination-requests": { "post": { "security": [ { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Compatibility alias", "Case termination" ], "operationId": "createOrCancelTerminationRequestV2", "summary": "Withdraw a pre-Answer claim or request termination without an Award", "description": "The acting side is derived from the role-bound credential and active case membership. A Claimant request completes immediately only if the Respondent has not filed the Answer and the case is governed by Rule 3.7. Otherwise both sides must independently confirm. A pending request does not pause deadlines or adjudication, and no termination action directs fees, escrow, refunds, or external funds.\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "parameters": [ { "$ref": "#/components/parameters/CaseId" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TerminationRequestInput" } } } }, "responses": { "200": { "description": "Existing request cancelled or replayed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreAwardTerminationResponse" } } } }, "201": { "description": "Termination requested or completed by pre-Answer withdrawal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreAwardTerminationResponse" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/cases/{caseId}/termination-requests/{requestId}/confirmations": { "post": { "security": [ { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Compatibility alias", "Case termination" ], "operationId": "confirmTerminationRequestV2", "summary": "Independently confirm a pending termination request", "description": "Confirmation must come from the side that did not initiate the request, using a role-bound termination capability and an active case membership that expressly permits case termination.\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "parameters": [ { "$ref": "#/components/parameters/CaseId" }, { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "expectedRevision" ], "properties": { "expectedRevision": { "type": "integer", "minimum": 0 }, "adoption": { "$ref": "#/components/schemas/RulesAdoptionAssent" }, "externalProtocolReference": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,200}$" } } } } } }, "responses": { "200": { "description": "Counterparty confirmation committed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreAwardTerminationResponse" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/cases/{caseId}/submissions": { "post": { "security": [ { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Compatibility alias", "Claims answers and submissions" ], "operationId": "submitPartyEvidenceV2", "summary": "Submit a stage-bound party brief and evidence", "parameters": [ { "$ref": "#/components/parameters/CaseId" }, { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/Party" }, { "$ref": "#/components/parameters/PartyToken" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "party", "brief" ], "properties": { "party": { "type": "string", "enum": [ "claimant", "respondent" ] }, "brief": { "type": "string" }, "files": { "type": "array", "items": { "type": "string", "contentEncoding": "binary" } }, "evidenceCandidateRefs": { "type": "string", "description": "JSON array of exportRecordId and artifactRef objects." } } } } } }, "responses": { "201": { "$ref": "#/components/responses/Data" }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "Replacement: /api/cases/{id}/submissions. Existing stage-bound filing body and attachments; canonical data/problem envelope. PATCH amendment has no replacement. Window: at least 180 days from equivalent canonical general availability and the published migration guide; dates are emitted only when the shared policy start is configured and canonical routes are enabled.", "description": "Submit a stage-bound party brief and evidence\n\nCompatibility alias. Replacement: /api/cases/{id}/submissions. Existing stage-bound filing body and attachments; canonical data/problem envelope. PATCH amendment has no replacement. Window: at least 180 days from equivalent canonical general availability and the published migration guide; dates are emitted only when the shared policy start is configured and canonical routes are enabled." } }, "/api/v2/cases/{caseId}/messages": { "get": { "security": [ { "platformOrchestratorBearer": [] }, { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Compatibility alias", "Messages" ], "operationId": "listProceduralMessagesV2", "summary": "List immutable shared procedural messages", "description": "Messages are ordered by creation time and ID. They are not part of, and do not mutate, the merits record.\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "parameters": [ { "$ref": "#/components/parameters/CaseId" } ], "responses": { "200": { "description": "Case-scoped procedural messages.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "additionalProperties": false, "required": [ "messages", "recordEffect" ], "properties": { "messages": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerProceduralMessage" } }, "recordEffect": { "type": "string", "const": "none" } } }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." }, "post": { "security": [ { "platformOrchestratorBearer": [] }, { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Compatibility alias", "Messages" ], "operationId": "createProceduralMessageV2", "summary": "Append an immutable non-merits procedural message", "description": "The acting side is derived from the credential and case membership. Platform orchestrators may issue procedural_notice only; party agents may use the other bounded categories. Evidence IDs are references to exchanged or admitted case evidence, never uploads or admissions. The immutable commit atomically enforces at most 20 messages per credential and case in a rolling hour.\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "parameters": [ { "$ref": "#/components/parameters/CaseId" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerProceduralMessageInput" } } } }, "responses": { "201": { "description": "Immutable message, or the canonical idempotent replay.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/PartnerProceduralMessage" }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/cases/{caseId}/evidence-candidates": { "get": { "security": [ { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Compatibility alias", "Evidence and challenges" ], "operationId": "listEvidenceCandidatesV2", "summary": "List verified evidence export candidates", "description": "Lists verified candidate artifacts shared with this case. Source/export tenant and authenticated adopter tenant remain distinct; active case-side authorization controls visibility and adoption.\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "parameters": [ { "$ref": "#/components/parameters/CaseId" }, { "$ref": "#/components/parameters/PartyToken" } ], "responses": { "200": { "description": "Case-scoped evidence candidates visible to the acting side.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/EvidenceCandidateList" }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/cases/{caseId}/restatement": { "get": { "security": [ { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Compatibility alias", "Record confirmation" ], "operationId": "getRestatementV2", "summary": "Read the acting side's proposed record restatement", "parameters": [ { "$ref": "#/components/parameters/CaseId" }, { "$ref": "#/components/parameters/PartyToken" } ], "responses": { "200": { "description": "Own-side record projection. Inventory cases reuse the hosted source-bound artifact, excluding private preparation custody; historical restatements retain their existing shape.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "requestId": { "type": "string" }, "data": { "type": "object", "properties": { "schemaVersion": { "type": "string", "enum": [ "party-restatement-v2", "party-restatement-response-v2" ] }, "caseId": { "type": "string" }, "party": { "type": "string", "enum": [ "claimant", "respondent" ] }, "preparationVersion": { "type": "string", "enum": [ "restatement-v1", "restatement-v2", "confirmed-request-inventory-v1" ], "description": "Legacy shared-deadline, historical source-bound, or prospective confirmed request-inventory preparation, respectively." }, "revision": { "type": "integer", "minimum": 0, "description": "Case revision to pass as expectedRevision when confirming this projection." }, "phase": { "type": "string" }, "confirmationDueAt": { "type": "string", "format": "date-time" }, "action": { "type": "string", "enum": [ "confirm", "correct" ] }, "applied": { "type": "boolean" }, "restatement": { "type": [ "object", "null" ], "properties": { "text": { "type": "string" }, "generatedAt": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "pending", "confirmed", "corrected", "lapsed" ] }, "respondedAt": { "type": "string", "format": "date-time" }, "correction": { "type": "string" }, "revision": { "type": "integer", "minimum": 0 }, "sourceSubmissionIds": { "type": "array", "items": { "type": "string" } }, "sourceContentHashes": { "type": "array", "items": { "type": "string" } }, "sourceFingerprint": { "type": "string" }, "confirmationDueAt": { "type": "string", "format": "date-time" }, "rejectedCorrections": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "reason": { "type": "string" }, "at": { "type": "string", "format": "date-time" } } } }, "requestInventory": { "type": "object", "description": "Frozen inventory shared with the hosted party view. Item identities, source bindings, amounts, and digests are returned exactly as recorded.", "properties": { "version": { "type": "string", "const": "confirmed-request-inventory-v1" }, "party": { "type": "string", "enum": [ "claimant", "respondent" ] }, "sourceFingerprint": { "type": "string" }, "restatementRevision": { "type": "integer", "minimum": 0 }, "parents": { "type": "array", "items": { "type": "object", "properties": { "parentId": { "type": "string" }, "claimId": { "type": "string" }, "title": { "type": "string" }, "statement": { "type": "string" }, "kind": { "type": "string", "enum": [ "monetary", "declaratory", "order" ] }, "currency": { "type": "string" } } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string" }, "parentId": { "type": "string" }, "parentClaimId": { "type": "string" }, "kind": { "type": "string", "enum": [ "monetary", "declaratory", "order" ] }, "fixedText": { "type": "string" }, "requestedAmount": { "type": "number", "description": "Original numeric amount in the frozen inventory artifact; do not replace it with a newly derived money value when confirming." }, "currency": { "type": "string" }, "canonicalDeclaration": { "type": "string" }, "canonicalOrder": { "type": "string" }, "residual": { "type": "boolean", "const": true }, "source": { "type": "object", "properties": { "sourceId": { "type": "string" }, "sourceContentHash": { "type": "string" }, "firstLine": { "type": "integer" }, "lastLine": { "type": "integer" }, "exactText": { "type": "string" } } }, "severableScopes": { "type": "array", "items": { "type": "object", "properties": { "scopeId": { "type": "string" }, "fixedText": { "type": "string" }, "source": { "$ref": "#/paths/~1api~1v2~1cases~1{caseId}~1restatement/get/responses/200/content/application~1json/schema/properties/data/properties/restatement/properties/requestInventory/properties/items/items/properties/source" } } } } } } }, "originalParentCoverage": { "type": "array", "items": { "type": "string" } }, "displayText": { "type": "string" }, "displayDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$", "description": "Exact confirmation digest; send unchanged as recordDigest or inventoryDigest. Do not re-derive it from prose." }, "inventoryHash": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "confirmed", "corrected", "lapsed" ] }, "respondedAt": { "type": "string", "format": "date-time" } } }, "priorRevisions": { "type": "array", "items": { "$ref": "#/paths/~1api~1v2~1cases~1{caseId}~1restatement/get/responses/200/content/application~1json/schema/properties/data/properties/restatement" } } } } } } } } } } }, "403": { "description": "The caller lacks party role or case proof, the requested side does not match the credential (party_mismatch), or an active membership lacks the required operation grant (case_operation_forbidden). Reads require case:read; record-confirmations POST requires record:confirm; restatement POST requires restatement:respond. Grants are checked before replay and mutation, including when a party token is supplied. Legacy owner cases without memberships retain party-token access.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Record confirmation refused without committing: record_confirmation_mismatch (digest or statement mismatch), record_confirmation_not_ready (current source-bound artifact unavailable), record_confirmation_resolved (already resolved), record_confirmation_expired (deadline passed), restatement_not_open (review stage unavailable), or case_changed (stale revision or concurrent update). The restatement route uses restatement_not_ready for an unavailable artifact and restatement_already_resolved for a resolved artifact. Inventory corrections through restatement POST return record_inventory_correction_hosted_only; use the hosted correction flow. Historical restatement errors remain unchanged.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "description": "Read the acting side's proposed record restatement\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." }, "post": { "security": [ { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Compatibility alias", "Record confirmation" ], "operationId": "respondToRestatementV2", "summary": "Confirm or correct the acting side's restatement", "description": "Under Rule 4.8, confirm the exact own-side inventory digest for confirmed-request-inventory-v1. Inventory accuracy corrections remain available through the hosted flow only; historical restatement correction behavior is unchanged.\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "parameters": [ { "$ref": "#/components/parameters/CaseId" }, { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/Party" }, { "$ref": "#/components/parameters/PartyToken" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "action" ], "properties": { "action": { "type": "string", "enum": [ "confirm", "correct" ] }, "correction": { "type": "string", "maxLength": 4000 }, "inventoryDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$", "description": "Exact requestInventory.displayDigest required to confirm an inventory-v1 artifact; optional for historical restatements." }, "expectedRevision": { "type": "integer", "minimum": 0, "description": "Case revision returned by GET. A stale revision returns case_changed without applying confirmation." } } } } } }, "responses": { "200": { "$ref": "#/paths/~1api~1v2~1cases~1{caseId}~1restatement/get/responses/200" }, "403": { "description": "The caller lacks party role or case proof, the requested side does not match the credential (party_mismatch), or an active membership lacks the required operation grant (case_operation_forbidden). Reads require case:read; record-confirmations POST requires record:confirm; restatement POST requires restatement:respond. Grants are checked before replay and mutation, including when a party token is supplied. Legacy owner cases without memberships retain party-token access.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Record confirmation refused without committing: record_confirmation_mismatch (digest or statement mismatch), record_confirmation_not_ready (current source-bound artifact unavailable), record_confirmation_resolved (already resolved), record_confirmation_expired (deadline passed), restatement_not_open (review stage unavailable), or case_changed (stale revision or concurrent update). The restatement route uses restatement_not_ready for an unavailable artifact and restatement_already_resolved for a resolved artifact. Inventory corrections through restatement POST return record_inventory_correction_hosted_only; use the hosted correction flow. Historical restatement errors remain unchanged.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/cases/{caseId}/record-confirmations": { "get": { "security": [ { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Compatibility alias", "Record confirmation" ], "operationId": "getRecordConfirmationV2", "summary": "Read the acting side's record-confirmation state", "parameters": [ { "$ref": "#/components/parameters/CaseId" }, { "$ref": "#/components/parameters/PartyToken" } ], "responses": { "200": { "description": "Own-side confirmation state. For inventory-v1, recordDigest is exactly restatement.requestInventory.displayDigest and restatement is the hosted party projection.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "requestId": { "type": "string" }, "data": { "type": "object", "properties": { "schemaVersion": { "type": "string", "const": "record-confirmation-v2" }, "caseId": { "type": "string" }, "party": { "type": "string", "enum": [ "claimant", "respondent" ] }, "status": { "type": "string", "enum": [ "pending", "confirmed", "lapsed" ] }, "submissionIds": { "type": "array", "items": { "type": "string" } }, "recordDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "confirmationStatement": { "type": "string" }, "phase": { "type": "string" }, "confirmedAt": { "type": "string", "format": "date-time" }, "preparationVersion": { "$ref": "#/paths/~1api~1v2~1cases~1{caseId}~1restatement/get/responses/200/content/application~1json/schema/properties/data/properties/preparationVersion" }, "revision": { "$ref": "#/paths/~1api~1v2~1cases~1{caseId}~1restatement/get/responses/200/content/application~1json/schema/properties/data/properties/revision" }, "confirmationDueAt": { "type": "string", "format": "date-time" }, "restatement": { "$ref": "#/paths/~1api~1v2~1cases~1{caseId}~1restatement/get/responses/200/content/application~1json/schema/properties/data/properties/restatement" } } } } } } } }, "403": { "description": "The caller lacks party role or case proof, the requested side does not match the credential (party_mismatch), or an active membership lacks the required operation grant (case_operation_forbidden). Reads require case:read; record-confirmations POST requires record:confirm; restatement POST requires restatement:respond. Grants are checked before replay and mutation, including when a party token is supplied. Legacy owner cases without memberships retain party-token access.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Record confirmation refused without committing: record_confirmation_mismatch (digest or statement mismatch), record_confirmation_not_ready (current source-bound artifact unavailable), record_confirmation_resolved (already resolved), record_confirmation_expired (deadline passed), restatement_not_open (review stage unavailable), or case_changed (stale revision or concurrent update). The restatement route uses restatement_not_ready for an unavailable artifact and restatement_already_resolved for a resolved artifact. Inventory corrections through restatement POST return record_inventory_correction_hosted_only; use the hosted correction flow. Historical restatement errors remain unchanged.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "Replacement: /api/cases/{id}/record-summary. Canonical own-side record summary and exact confirmation requirements; inspect data before writing. Window: at least 180 days from equivalent canonical general availability and the published migration guide; dates are emitted only when the shared policy start is configured and canonical routes are enabled.", "description": "Read the acting side's record-confirmation state\n\nCompatibility alias. Replacement: /api/cases/{id}/record-summary. Canonical own-side record summary and exact confirmation requirements; inspect data before writing. Window: at least 180 days from equivalent canonical general availability and the published migration guide; dates are emitted only when the shared policy start is configured and canonical routes are enabled." }, "post": { "security": [ { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Compatibility alias", "Record confirmation" ], "operationId": "confirmRecordV2", "summary": "Confirm the acting side's immutable record digest", "description": "Under Rule 4.8, submit the exact recordDigest and confirmationStatement returned by GET. For confirmed-request-inventory-v1 this confirms the shared hosted inventory through the same commit path. The acting side, current source, case revision, review stage, and confirmation deadline are enforced; repeat requests with the same Idempotency-Key replay the committed response.\n\nCompatibility alias. Replacement: /api/cases/{id}/record-summary/confirmations. Send exact server digest and confirmation text; same keyed confirmation journal. Window: at least 180 days from equivalent canonical general availability and the published migration guide; dates are emitted only when the shared policy start is configured and canonical routes are enabled.", "parameters": [ { "$ref": "#/components/parameters/CaseId" }, { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/Party" }, { "$ref": "#/components/parameters/PartyToken" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "recordDigest", "confirmationStatement" ], "properties": { "recordDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "confirmationStatement": { "type": "string" }, "expectedRevision": { "type": "integer", "minimum": 0, "description": "Case revision returned by GET. A stale revision returns case_changed without applying confirmation." } } } } } }, "responses": { "200": { "$ref": "#/paths/~1api~1v2~1cases~1{caseId}~1record-confirmations/get/responses/200" }, "403": { "description": "The caller lacks party role or case proof, the requested side does not match the credential (party_mismatch), or an active membership lacks the required operation grant (case_operation_forbidden). Reads require case:read; record-confirmations POST requires record:confirm; restatement POST requires restatement:respond. Grants are checked before replay and mutation, including when a party token is supplied. Legacy owner cases without memberships retain party-token access.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Record confirmation refused without committing: record_confirmation_mismatch (digest or statement mismatch), record_confirmation_not_ready (current source-bound artifact unavailable), record_confirmation_resolved (already resolved), record_confirmation_expired (deadline passed), restatement_not_open (review stage unavailable), or case_changed (stale revision or concurrent update). The restatement route uses restatement_not_ready for an unavailable artifact and restatement_already_resolved for a resolved artifact. Inventory corrections through restatement POST return record_inventory_correction_hosted_only; use the hosted correction flow. Historical restatement errors remain unchanged.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "Replacement: /api/cases/{id}/record-summary/confirmations. Send exact server digest and confirmation text; same keyed confirmation journal. Window: at least 180 days from equivalent canonical general availability and the published migration guide; dates are emitted only when the shared policy start is configured and canonical routes are enabled." } }, "/api/v2/cases/{caseId}/docket": { "get": { "security": [ { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Compatibility alias", "Cases and drafts" ], "operationId": "getDocketV2", "summary": "Read the case docket projection", "parameters": [ { "$ref": "#/components/parameters/CaseId" }, { "$ref": "#/components/parameters/PartyToken" } ], "responses": { "200": { "$ref": "#/components/responses/Data" }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "Replacement: /api/cases/{id}/events. Same partner-authorized event cursor; hosted docket has no equivalent canonical session read. Window: at least 180 days from equivalent canonical general availability and the published migration guide; dates are emitted only when the shared policy start is configured and canonical routes are enabled.", "description": "Read the case docket projection\n\nCompatibility alias. Replacement: /api/cases/{id}/events. Same partner-authorized event cursor; hosted docket has no equivalent canonical session read. Window: at least 180 days from equivalent canonical general availability and the published migration guide; dates are emitted only when the shared policy start is configured and canonical routes are enabled." } }, "/api/v2/cases/{caseId}/award": { "get": { "security": [ { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Compatibility alias", "Decisions and finality" ], "operationId": "getServedAwardV2", "summary": "Read the served Award", "description": "Returns the deterministic public decision projection derived from the immutable signed award-decision-v2 revision, never a mutable live disposition. It contains no internal dispute ID and no recipe-v3 manifest or verification envelope. Known internal IDs are replaced even when embedded in strings; every recognized money key must be numeric internally, null, or exact FiatMoney, every present amounts field must be an exact-money array, and malformed values or residual internal-ID patterns fail closed. companionArtifacts advertises PDF, DOCX, and canonical award-decision-v2 JSON descriptors through a closed-schema, separately signed, public-case-bound companion attestation.\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "parameters": [ { "$ref": "#/components/parameters/CaseId" }, { "$ref": "#/components/parameters/PartyToken" } ], "responses": { "200": { "$ref": "#/components/responses/Data" }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/cases/{caseId}/decision-status": { "get": { "security": [ { "platformOrchestratorBearer": [] }, { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] }, { "readOnlyObserverBearer": [] } ], "tags": [ "Compatibility alias", "Decisions and finality", "Settlement" ], "operationId": "getDecisionStatusV2", "summary": "Read decision service, finality, and settlement status", "parameters": [ { "$ref": "#/components/parameters/CaseId" }, { "$ref": "#/components/parameters/PartyToken" } ], "responses": { "200": { "$ref": "#/components/responses/Data" }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "description": "Read decision service, finality, and settlement status\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/cases/{caseId}/evaluation": { "get": { "security": [ { "platformOrchestratorBearer": [] }, { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Compatibility alias", "Narrow evaluations" ], "operationId": "getNarrowEvaluationV2", "summary": "Read the immutable evaluation definition and any served result", "description": "Returns pending or review state until an Award is served. A served result maps only to the three outcomes authorized in the evaluation draft.\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "parameters": [ { "$ref": "#/components/parameters/CaseId" }, { "$ref": "#/components/parameters/PartyToken" } ], "responses": { "200": { "description": "Narrow evaluation state and result projection.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/NarrowEvaluationResource" }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/cases/{caseId}/evaluation/accept": { "post": { "security": [ { "respondentAgentBearer": [] } ], "tags": [ "Compatibility alias", "Narrow evaluations", "Participants invitations and authority" ], "operationId": "acceptNarrowEvaluationV2", "summary": "Accept a claimant-proposed narrow evaluation", "description": "Redeems the one-time respondent invitation and binds the respondent to the exact evaluation digest before evidence opens. Idempotency is resolved before mutable invitation/case-state validation: the same key and body replay the stored 201 without the show-once capability, while a different body returns idempotency_conflict.\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "parameters": [ { "$ref": "#/components/parameters/CaseId" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NarrowEvaluationAcceptanceInput" } } } }, "responses": { "201": { "description": "Evaluation accepted; the respondent party capability is returned once.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/NarrowEvaluationAcceptance" }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/cases/{caseId}/settlement-binding": { "post": { "security": [ { "platformOrchestratorBearer": [] } ], "tags": [ "Compatibility alias", "Settlement" ], "operationId": "createSettlementBindingV2", "summary": "Bind a case to one external settlement corpus", "description": "A platform orchestrator registers the USD-only binding only after bilateral authorization and while the dispute is in awaiting_submissions or awaiting_validation, with no Award. The server atomically checks the current dispute revision/status, derives immutable actor and authority-grant metadata, and binds that metadata with the evaluation digest, action subset, participant identities, adapter, and corpus limits. An exact idempotent replay remains valid after the registration window closes.\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "parameters": [ { "$ref": "#/components/parameters/CaseId" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerSettlementBindingInput" } } } }, "responses": { "201": { "description": "Immutable settlement binding created or idempotently replayed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/PartnerSettlementBinding" }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." }, "get": { "security": [ { "platformOrchestratorBearer": [] }, { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Compatibility alias", "Settlement" ], "operationId": "getSettlementBindingV2", "summary": "Read the case's settlement binding", "parameters": [ { "$ref": "#/components/parameters/CaseId" } ], "responses": { "200": { "description": "Digest-bound settlement binding.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/PartnerSettlementBinding" }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "description": "Read the case's settlement binding\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/cases/{caseId}/settlement-executions": { "post": { "security": [ { "settlementAdapterBearer": [] }, { "CanonicalPartnerBearer": [] }, { "CanonicalSession": [] }, { "AccountOAuth": [ "executions:report" ] } ], "tags": [ "Compatibility alias", "Settlement" ], "operationId": "executeSettlementV2", "summary": "Validate or execute the authorized settlement action", "description": "Requires a credential with the dedicated settlement:execute capability bound to the exact adapter. The action is derived from the served evaluation outcome, never supplied by the caller. Dry runs append a validated receipt; live calls append an immutable caller attempt linked to one server-derived business-operation journal. Different caller idempotency keys cannot resubmit the same binding, operative Award revision/hash, and action. Unknown provider outcomes require reconciliation before any terminal result is reported.\n\nCompatibility alias. New Award execution commands use /api/cases/{id}/executions. The historical digest-bound input and response remain supported here. Its compatibility window has not started.", "parameters": [ { "$ref": "#/components/parameters/CaseId" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PartnerSettlementExecutionInput" }, { "$ref": "#/components/schemas/AwardExecutionCommand" } ] } } } }, "responses": { "201": { "description": "Legacy digest input returns an immutable attempt; action input returns the canonical Award execution resource.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/PartnerSettlementAttempt" }, { "$ref": "#/components/schemas/AwardExecutionResource" } ] }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "The legacy digest contract remains supported. New action commands use /api/cases/{id}/executions. No retirement window has started." }, "get": { "security": [ { "settlementAdapterBearer": [] } ], "tags": [ "Compatibility alias", "Settlement" ], "operationId": "listSettlementExecutionsV2", "summary": "List settlement attempts and business operations", "parameters": [ { "$ref": "#/components/parameters/CaseId" } ], "responses": { "200": { "description": "Immutable caller attempts and the authoritative business-operation journal.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "caseId", "attempts", "operations" ], "properties": { "schemaVersion": { "type": "string", "const": "partner-settlement-attempt-list-v2" }, "caseId": { "type": "string" }, "attempts": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerSettlementAttempt" } }, "operations": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerSettlementOperation" } } } }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "description": "List settlement attempts and business operations\n\nCompatibility alias. New Award execution commands use /api/cases/{id}/executions. The historical digest-bound input and response remain supported here. Its compatibility window has not started." } }, "/api/v2/cases/{caseId}/award/artifacts/{kind}": { "get": { "security": [ { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Compatibility alias", "Decisions and finality" ], "operationId": "downloadAwardArtifactV2", "summary": "Download an exact served Award artifact", "description": "PDF and DOCX retain their frozen source bytes and JSON is a separately persisted canonical award-decision-v2 exact-money derivative. The public v2 response omits the internal-identity-bearing recipe-v3 envelope. Verify every download through the signed companion attestation, which binds public case IDs, derivative artifact identity and bytes, source Award hash/disposition/revision, and all three source descriptors.\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "parameters": [ { "$ref": "#/components/parameters/CaseId" }, { "$ref": "#/components/parameters/PartyToken" }, { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "pdf", "docx", "json" ] } } ], "responses": { "200": { "description": "Exact served award bytes." }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/cases/{caseId}/award/artifacts/json/attestation": { "get": { "security": [ { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Compatibility alias", "Decisions and finality" ], "operationId": "getAwardJsonAttestationV2", "summary": "Read the signed v2 JSON Award companion attestation", "description": "Returns the separately signed public-case-bound derivative attestation and exact PDF/DOCX/JSON source descriptor set. The attestation is a closed schema, so undeclared fields fail verification. The recipe-v3 bytes remain unchanged in v1 storage but its internal-identity-bearing manifest and verification envelope are not exposed by v2.\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "parameters": [ { "$ref": "#/components/parameters/CaseId" }, { "$ref": "#/components/parameters/PartyToken" } ], "responses": { "200": { "$ref": "#/components/responses/Data" }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/cases/{caseId}/record-bundle": { "get": { "security": [ { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Compatibility alias", "Decisions and finality" ], "operationId": "downloadCaseRecordBundleV2", "summary": "Download a v2 party record manifest or full verified bundle", "description": "Both forms use the isolated case-record-bundle-v2 identity and exact-money canonical JSON. Manifest responses and full bundles carry a signed v2 attestation binding partner, public case IDs, side, revision, Rules, bundle identity, and every file digest. Verification scans the entire canonical artifact for internal IDs and requires case, docket, messages, applicable decisions, and a validated award-decision-v2 plus matching trusted attestation for every required revision; filenames alone never establish completeness. The opaque sourceSnapshotHash supports deterministic cache identity without exposing any v1 source bundle ID; no recipe-v3 envelope, v1 bundle ID, or v1 cache row is exposed or reused.\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "parameters": [ { "$ref": "#/components/parameters/CaseId" }, { "$ref": "#/components/parameters/PartyToken" }, { "name": "format", "in": "query", "schema": { "type": "string", "enum": [ "manifest", "bundle" ], "default": "manifest" } } ], "responses": { "200": { "description": "Party record integrity manifest envelope or canonical full bundle bytes." }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/cases/{caseId}/evidence/{evidenceId}/authenticity-challenges": { "get": { "security": [ { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Compatibility alias", "Evidence and challenges" ], "operationId": "getAuthenticityChallengesV2", "summary": "List all party-visible challenges for an evidence item", "description": "Requires evidence:challenges:read plus active tenant case membership and side binding. Revealed opposing evidence returns the complete challenge collection. Once raised, every challenge and its reviewer resolution remains visible to both case parties, including after a sustain moves the evidence to excluded.\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "parameters": [ { "$ref": "#/components/parameters/CaseId" }, { "name": "evidenceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/PartyToken" } ], "responses": { "200": { "description": "Every visible challenge and reviewer resolution status.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/PartnerAuthenticityChallengeList" }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." }, "post": { "security": [ { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Compatibility alias", "Evidence and challenges" ], "operationId": "raiseAuthenticityChallengeV2", "summary": "Challenge revealed opposing evidence", "description": "Requires evidence:challenges:write, Idempotency-Key, active tenant case membership, and the credential-bound side. The sanitized challenge is audit logged and docketed. Raising it contests weight only and never excludes evidence. Current Rules assign authenticity, admissibility, reliability, and weight to the AI Tribunal; historical cases retain their pinned assigned reviewer. A challenge may alternatively be embedded in a sealed rebuttal as challenges[]. Those entries are validated when filed and committed only at joint reveal, so they do not leak before the rebuttal opens.\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "parameters": [ { "$ref": "#/components/parameters/CaseId" }, { "name": "evidenceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/PartyToken" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerAuthenticityChallengeInput" } } } }, "responses": { "200": { "description": "An already-open semantic challenge was returned without another write.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/PartnerAuthenticityChallenge" }, "requestId": { "type": "string" } } } } } }, "201": { "description": "Challenge newly raised, or the canonical replay of that creation response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/PartnerAuthenticityChallenge" }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/evidence-exports/notifications": { "post": { "security": [ { "evidenceExporterBearer": [] } ], "tags": [ "Compatibility alias", "Evidence and challenges" ], "operationId": "notifyEvidenceExportV2", "summary": "Notify the court of a signed evidence export", "description": "Requires the evidence_exporter bearer role and all seven exporter Ed25519 transport-signing headers. This signed mutation does not use Idempotency-Key; it deduplicates by the signed exporter and event identity. When the exporter has an enrolled A-Comm artifact-attestation policy, the receiver also verifies required inline artifact attestations natively and persists the exact verification proof. Transport and artifact keys are separate trust domains.\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "parameters": [ { "$ref": "#/components/parameters/ContentDigest" }, { "$ref": "#/components/parameters/PcEventId" }, { "$ref": "#/components/parameters/PcEventTimestamp" }, { "$ref": "#/components/parameters/PcKeyId" }, { "$ref": "#/components/parameters/EvidenceSchemaVersion" }, { "$ref": "#/components/parameters/PcSignatureVersion" }, { "$ref": "#/components/parameters/PcSignature" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvidenceExportNotification" } } } }, "responses": { "200": { "description": "Duplicate event; the original receipt facts are returned with duplicate status.", "headers": { "x-pc-trace-id": { "$ref": "#/components/headers/EvidenceNotificationTraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvidenceIngestReceiptEnvelope" } } } }, "202": { "description": "New evidence notification processed.", "headers": { "x-pc-trace-id": { "$ref": "#/components/headers/EvidenceNotificationTraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvidenceIngestReceiptEnvelope" } } } }, "409": { "description": "The event/export identity conflicted, or the authenticated exporter attestation policy changed during ingest. No receipt, export record, or blob is committed on a policy-fence conflict.", "headers": { "x-pc-trace-id": { "$ref": "#/components/headers/EvidenceNotificationTraceId" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "default": { "description": "Request rejected. Pre-ingest authentication or authorization failures return no evidence receipt or export record.", "headers": { "x-pc-trace-id": { "$ref": "#/components/headers/EvidenceNotificationTraceId" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/evidence-exports/receipts/{eventId}": { "get": { "security": [ { "evidenceExporterBearer": [] } ], "tags": [ "Compatibility alias", "Evidence and challenges" ], "operationId": "getEvidenceExportReceiptV2", "summary": "Read an evidence export receipt", "parameters": [ { "name": "eventId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Stored ingest receipt.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvidenceIngestReceiptEnvelope" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.", "description": "Read an evidence export receipt\n\nCompatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route." } }, "/api/v2/webhooks/endpoints": { "post": { "security": [ { "platformOrchestratorBearer": [] } ], "tags": [ "Compatibility alias", "Webhooks" ], "operationId": "createOrRotateWebhookEndpointV2", "summary": "Register or rotate the partner callback endpoint", "description": "Resolves and validates a public HTTPS destination before registration. Private, loopback, link-local, metadata, failed-DNS, and mixed-address targets are rejected; delivery revalidates and pins DNS. Compatibility alias for /api/webhooks/endpoints. Its compatibility window has not started.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerWebhookEndpointInput" } } } }, "responses": { "201": { "$ref": "#/components/responses/Data" }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "Canonical replacement published; outside the automatic retirement cohort." }, "get": { "security": [ { "platformOrchestratorBearer": [] } ], "tags": [ "Compatibility alias", "Webhooks" ], "operationId": "listWebhookEndpointsV2", "summary": "List registered partner callback endpoints", "responses": { "200": { "$ref": "#/components/responses/Data" }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "Canonical replacement published; outside the automatic retirement cohort.", "description": "List registered partner callback endpoints Compatibility alias for /api/webhooks/endpoints. Its compatibility window has not started." } }, "/api/v2/webhooks/deliveries": { "get": { "security": [ { "platformOrchestratorBearer": [] } ], "tags": [ "Compatibility alias", "Webhooks" ], "operationId": "listWebhookDeliveriesV2", "summary": "List tenant-scoped webhook deliveries", "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "pending", "sending", "delivered", "failed", "suppressed", "dead_letter" ] } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 100 } } ], "responses": { "200": { "description": "Tenant-scoped delivery history.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "required": [ "schemaVersion", "deliveries" ], "properties": { "schemaVersion": { "type": "string", "const": "partner-webhook-delivery-list-v2" }, "deliveries": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerWebhookDelivery" } } } }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "Canonical replacement published; outside the automatic retirement cohort.", "description": "List tenant-scoped webhook deliveries Compatibility alias for /api/webhooks/deliveries. Its compatibility window has not started." } }, "/api/v2/webhooks/deliveries/{deliveryId}": { "get": { "security": [ { "platformOrchestratorBearer": [] } ], "tags": [ "Compatibility alias", "Webhooks" ], "operationId": "getWebhookDeliveryV2", "summary": "Read one webhook delivery and its attempts", "parameters": [ { "$ref": "#/components/parameters/WebhookDeliveryId" } ], "responses": { "200": { "description": "Delivery and immutable attempt history.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/PartnerWebhookDelivery" }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "Canonical replacement published; outside the automatic retirement cohort.", "description": "Read one webhook delivery and its attempts Compatibility alias for /api/webhooks/deliveries/{id}. Its compatibility window has not started." } }, "/api/v2/webhooks/deliveries/{deliveryId}/replay": { "post": { "security": [ { "platformOrchestratorBearer": [] } ], "tags": [ "Compatibility alias", "Webhooks" ], "operationId": "replayWebhookDeliveryV2", "summary": "Append an operator-requested delivery for an existing logical event", "parameters": [ { "$ref": "#/components/parameters/WebhookDeliveryId" }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false } } } }, "responses": { "201": { "description": "New delivery for the existing logical event.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/PartnerWebhookDelivery" }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-window": "Canonical replacement published; outside the automatic retirement cohort.", "description": "Append an operator-requested delivery for an existing logical event Compatibility alias for /api/webhooks/deliveries/{id}/replay. Its compatibility window has not started." } }, "/.well-known/oauth-authorization-server": { "get": { "operationId": "getAccountOAuthMetadata", "summary": "Discover the People’s Court account authorization server", "tags": [ "Account OAuth" ], "security": [], "description": "Discover the People’s Court account authorization server", "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "issuer": { "type": "string" }, "authorization_endpoint": { "type": "string" }, "token_endpoint": { "type": "string" }, "revocation_endpoint": { "type": "string" }, "introspection_endpoint": { "type": "string" }, "response_types_supported": { "type": "array", "items": { "type": "string" } }, "grant_types_supported": { "type": "array", "items": { "type": "string" } }, "code_challenge_methods_supported": { "type": "array", "items": { "type": "string" } }, "token_endpoint_auth_methods_supported": { "type": "array", "items": { "type": "string" } }, "scopes_supported": { "type": "array", "items": { "type": "string", "enum": [ "cases:read", "filings:write", "answers:write", "submissions:write", "records:confirm", "records:write", "invitations:write", "messages:write", "remedies:write", "consents:write", "offline_access", "representatives:manage", "procedural:request", "termination:write" ] } } } } } } }, "default": { "description": "Authorization failure; consent_required requires explicit reacceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountOAuthError" } } } } } } }, "/api/oauth/clients": { "get": { "operationId": "listAccountOAuthClients", "summary": "List own clients, grants and notices", "tags": [ "Authorizations" ], "security": [ { "CanonicalSession": [] } ], "description": "List own clients, grants and notices", "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountAuthorizations" } } } }, "default": { "description": "Authorization failure; consent_required requires explicit reacceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountOAuthError" } } } } } }, "post": { "operationId": "registerAccountOAuthClient", "summary": "Register an account-bound client", "tags": [ "Authorizations" ], "security": [ { "CanonicalSession": [] } ], "description": "Verified account email required. Agent clients require complete registered agent identity. Partner clients require approved tenant administration. Exact HTTPS/loopback redirects. Cookie writes require the issuer Origin.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "kind": { "type": "string", "enum": [ "personal", "agent", "partner" ] }, "redirectUris": { "type": "array", "items": { "type": "string" } }, "scope": { "type": "array", "items": { "type": "string", "enum": [ "cases:read", "filings:write", "answers:write", "submissions:write", "records:confirm", "records:write", "invitations:write", "messages:write", "remedies:write", "consents:write", "offline_access", "representatives:manage", "procedural:request", "termination:write" ] } }, "partnerId": { "type": "string" }, "mcpCaseId": { "type": "string" } }, "required": [ "name", "kind", "scope" ] } } } }, "responses": { "201": { "description": "Successful operation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "client": { "$ref": "#/components/schemas/AccountOAuthClient" }, "clientSecret": { "type": "string", "description": "Confidential clients only; shown once." } }, "required": [ "client" ] } } } }, "default": { "description": "Authorization failure; consent_required requires explicit reacceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountOAuthError" } } } } } }, "delete": { "operationId": "revokeAccountOAuthClient", "summary": "Revoke an owned client", "tags": [ "Authorizations" ], "security": [ { "CanonicalSession": [] } ], "description": "Revoke an owned client", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "revoked": { "type": "boolean" } }, "required": [ "revoked" ] } } } }, "default": { "description": "Authorization failure; consent_required requires explicit reacceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountOAuthError" } } } } } } }, "/api/oauth/authorize": { "post": { "operationId": "reviewAccountOAuthAuthorization", "summary": "Prepare or approve a signed-in authorization request", "tags": [ "Authorizations" ], "security": [ { "CanonicalSession": [] } ], "description": "The hosted /oauth/authorize page performs this same-origin session-authenticated protocol. Review exact scopes, Rules/disclosure and optional standing bounds before approval. A link request must be owned by an approved partner and the account must already be a party to its case.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "action": { "type": "string", "const": "prepare" }, "client_id": { "type": "string" }, "redirect_uri": { "type": "string" }, "response_type": { "type": "string", "const": "code" }, "code_challenge_method": { "type": "string", "const": "S256" }, "code_challenge": { "type": "string" }, "scope": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string", "enum": [ "cases:read", "filings:write", "answers:write", "submissions:write", "records:confirm", "records:write", "invitations:write", "messages:write", "remedies:write", "consents:write", "offline_access", "representatives:manage", "procedural:request", "termination:write" ] } } ] }, "resource": { "type": "string" }, "state": { "type": "string" }, "case_id": { "type": "string" }, "party": { "type": "string", "enum": [ "claimant", "respondent" ], "description": "Require this side of the existing case; approval binds the current party membership." }, "standing_offer": { "type": "boolean" } }, "required": [ "action", "client_id", "redirect_uri", "response_type", "code_challenge_method", "code_challenge", "scope", "resource", "state" ] }, { "type": "object", "properties": { "action": { "type": "string", "const": "prepare" }, "link": { "type": "string" } }, "required": [ "action", "link" ] }, { "type": "object", "properties": { "action": { "type": "string", "const": "approve" }, "requestId": { "type": "string" }, "approve": { "type": "boolean" }, "terms": { "$ref": "#/components/schemas/AccountOAuthTerms" }, "standing": { "$ref": "#/components/schemas/AccountStandingBounds" } }, "required": [ "action", "requestId", "approve", "terms" ] } ] } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "request": { "type": "object", "properties": { "id": { "type": "string" }, "clientId": { "type": "string" }, "principalId": { "type": "string" }, "redirectUri": { "type": "string" }, "scope": { "type": "array", "items": { "type": "string", "enum": [ "cases:read", "filings:write", "answers:write", "submissions:write", "records:confirm", "records:write", "invitations:write", "messages:write", "remedies:write", "consents:write", "offline_access", "representatives:manage", "procedural:request", "termination:write" ] } }, "resource": { "type": "string" }, "caseId": { "type": "string" }, "terms": { "$ref": "#/components/schemas/AccountOAuthTerms" }, "expiresAt": { "type": "string" } } }, "client": { "$ref": "#/components/schemas/AccountOAuthClient" } }, "required": [ "request", "client" ] }, { "type": "object", "properties": { "redirect": { "type": "string" }, "grant": { "$ref": "#/components/schemas/AccountAuthorityGrant" } }, "required": [ "redirect" ] } ] } } } }, "default": { "description": "Authorization failure; consent_required requires explicit reacceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountOAuthError" } } } } } } }, "/api/oauth/token": { "post": { "operationId": "exchangeAccountOAuthToken", "summary": "Exchange code, rotate refresh, or issue registered-agent token", "tags": [ "Authorizations" ], "security": [], "description": "Public personal clients send client_id. Confidential clients authenticate using Basic or body credentials. Code exchange requires exact redirect and S256 verifier; refresh cannot widen scope. Code and refresh reuse revoke authority. Changed Rules/disclosure returns consent_required.", "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "client_id": { "type": "string" }, "client_secret": { "type": "string", "writeOnly": true }, "grant_type": { "type": "string", "enum": [ "authorization_code", "refresh_token", "client_credentials" ] }, "code": { "type": "string" }, "code_verifier": { "type": "string" }, "redirect_uri": { "type": "string" }, "refresh_token": { "type": "string" }, "scope": { "type": "string" }, "resource": { "type": "string" } }, "required": [ "grant_type", "resource" ], "example": { "client_id": "COPY_REGISTERED_CLIENT_ID", "resource": "https://peoplescourt.ai/api", "grant_type": "authorization_code", "code": "COPY_CALLBACK_CODE", "code_verifier": "COPY_SAVED_PKCE_VERIFIER", "redirect_uri": "https://your-app.example/callback" } } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountOAuthTokens" } } } }, "default": { "description": "Authorization failure; consent_required requires explicit reacceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountOAuthError" } } } } } } }, "/api/oauth/revoke": { "post": { "operationId": "revokeAccountOAuthToken", "summary": "Revoke a token and its grant", "tags": [ "Authorizations" ], "security": [], "description": "Revoke a token and its grant", "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "client_id": { "type": "string" }, "client_secret": { "type": "string", "writeOnly": true }, "token": { "type": "string" }, "resource": { "type": "string" } }, "required": [ "token" ], "example": { "client_id": "COPY_REGISTERED_CLIENT_ID", "token": "COPY_TOKEN_TO_REVOKE" } } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "default": { "description": "Authorization failure; consent_required requires explicit reacceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountOAuthError" } } } } } } }, "/api/oauth/introspect": { "post": { "operationId": "introspectAccountOAuthToken", "summary": "Inspect a live token using confidential client authentication", "tags": [ "Authorizations" ], "security": [], "description": "Inspect a live token using confidential client authentication", "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "client_id": { "type": "string" }, "client_secret": { "type": "string", "writeOnly": true }, "token": { "type": "string" }, "resource": { "type": "string" } }, "required": [ "token", "resource" ], "example": { "client_id": "COPY_REGISTERED_CLIENT_ID", "resource": "https://peoplescourt.ai/api", "client_secret": "COPY_CONFIDENTIAL_CLIENT_SECRET", "token": "COPY_TOKEN_TO_INSPECT" } } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "active": { "type": "boolean" }, "sub": { "type": "string" }, "client_id": { "type": "string" }, "aud": { "type": "string" }, "iss": { "type": "string" }, "scope": { "type": "string" }, "exp": { "type": "integer" }, "iat": { "type": "integer" }, "case_id": { "type": "string" }, "tenant_id": { "type": "string" } }, "required": [ "active" ] } } } }, "default": { "description": "Authorization failure; consent_required requires explicit reacceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountOAuthError" } } } } } } }, "/api/oauth/link-requests": { "post": { "operationId": "requestAccountCaseLink", "summary": "Request a principal’s approval to delegate an existing case", "tags": [ "Authorizations" ], "security": [], "description": "Confidential approved partner client authentication required. The one-hour, single-use hosted approval link creates the same case-bound delegate grant as ordinary OAuth. Approval binds the current case membership and side; each token use rechecks that membership. Approval or denial consumes the link. A new case is never created.", "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "client_id": { "type": "string" }, "client_secret": { "type": "string", "writeOnly": true }, "case_id": { "type": "string" }, "party": { "type": "string", "enum": [ "claimant", "respondent" ], "description": "Requested case side. Use respondent for a respondent handoff." }, "redirect_uri": { "type": "string" }, "scope": { "type": "string" }, "state": { "type": "string" }, "code_challenge_method": { "type": "string", "const": "S256" }, "code_challenge": { "type": "string" } }, "required": [ "case_id", "redirect_uri", "scope", "state", "code_challenge_method", "code_challenge" ], "example": { "client_id": "COPY_REGISTERED_CLIENT_ID", "client_secret": "COPY_CONFIDENTIAL_CLIENT_SECRET", "case_id": "pcase_existing", "party": "respondent", "redirect_uri": "https://your-app.example/callback", "scope": "cases:read", "state": "COPY_FRESH_STATE", "code_challenge_method": "S256", "code_challenge": "COPY_FRESH_S256_CHALLENGE" } } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "approvalUrl": { "type": "string" }, "expiresAt": { "type": "string" } }, "required": [ "approvalUrl", "expiresAt" ] } } } }, "default": { "description": "Authorization failure; consent_required requires explicit reacceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountOAuthError" } } } } } } }, "/api/authorizations/authority-grants": { "get": { "operationId": "listAccountAuthorityGrants", "summary": "List own authority grants and standing consent notices", "tags": [ "Authorizations" ], "security": [ { "CanonicalSession": [] } ], "description": "List own authority grants and standing consent notices", "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "grants": { "type": "array", "items": { "$ref": "#/components/schemas/AccountAuthorityGrant" } }, "notices": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "grantId": { "type": "string" }, "caseId": { "type": "string" }, "termsDigest": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "grantId", "caseId", "termsDigest", "createdAt" ] } } }, "required": [ "grants", "notices" ] } } } }, "default": { "description": "Authorization failure; consent_required requires explicit reacceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountOAuthError" } } } } } }, "post": { "operationId": "createAccountAuthorityGrant", "summary": "Explicitly approve bounded standing or existing-case authority", "tags": [ "Authorizations" ], "security": [ { "CanonicalSession": [] } ], "description": "A signed-in verified principal explicitly accepts current terms. Name a case already owned by that principal or bounded standing authority. Acts, USD cap, expiry, ordinary clock, standard procedure and optional transaction scope are checked server-side. Standing authority lapses when Rules or disclosure changes.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "clientId": { "type": "string" }, "scope": { "type": "array", "items": { "type": "string", "enum": [ "cases:read", "filings:write", "answers:write", "submissions:write", "records:confirm", "records:write", "invitations:write", "messages:write", "remedies:write", "consents:write", "offline_access", "representatives:manage", "procedural:request", "termination:write" ] } }, "caseId": { "type": "string" }, "standing": { "$ref": "#/components/schemas/AccountStandingBounds" }, "accepted": { "type": "boolean", "const": true }, "terms": { "$ref": "#/components/schemas/AccountOAuthTerms" } }, "required": [ "clientId", "scope", "accepted", "terms" ] } } } }, "responses": { "201": { "description": "Successful operation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "grant": { "$ref": "#/components/schemas/AccountAuthorityGrant" } }, "required": [ "grant" ] } } } }, "default": { "description": "Authorization failure; consent_required requires explicit reacceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountOAuthError" } } } } } }, "delete": { "operationId": "revokeAccountAuthorityGrant", "summary": "Revoke an owned authority grant immediately", "tags": [ "Authorizations" ], "security": [ { "CanonicalSession": [] } ], "description": "Revoke an owned authority grant immediately", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "revoked": { "type": "boolean" } }, "required": [ "revoked" ] } } } }, "default": { "description": "Authorization failure; consent_required requires explicit reacceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountOAuthError" } } } } } } }, "/api/authorizations/consents": { "post": { "operationId": "acceptAccountFilingPacket", "summary": "Accept an exact prepared filing as its designated principal", "tags": [ "Authorizations" ], "security": [ { "AccountOAuth": [ "consents:write" ] } ], "description": "The designated principal explicitly accepts the exact packet. For a standing-bound OAuth token, amount, acts, transaction, procedure, clock and current terms are checked; standing consent and a principal notice commit atomically, and confirmation rechecks revocation. A personal-client grant cannot be applied by a preparing partner merely by knowing its ID.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "draftId": { "type": "string" }, "termsDigest": { "type": "string" }, "acceptanceStatement": { "type": "string" } }, "required": [ "draftId", "termsDigest", "acceptanceStatement" ] } } } }, "responses": { "201": { "description": "Successful operation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "accepted": { "const": true }, "termsDigest": { "type": "string" }, "attestationHash": { "type": "string" } } } } } } } }, "default": { "description": "Authorization failure; consent_required requires explicit reacceptance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountOAuthError" } } } } } } }, "/api/cases": { "get": { "operationId": "listAccountCases", "summary": "List the approving account’s cases", "tags": [ "Cases and participation" ], "description": "Flag-gated account operation over the existing hosted authorization boundary. Requires the approving account’s current party access. OAuth never grants administrator or reviewer authority. Returns at most 50 memberships by default (maximum 100), optionally filtered by side and stored case status. Follow the Link header with rel=\"next\" using the same account and filters; its opaque after cursor is bound to them. Limit may change between pages. There is no nextCursor in the body. The website-specific request branch retains its separate hosted contract.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "side", "in": "query", "schema": { "type": "string", "enum": [ "claimant", "respondent" ] } }, { "name": "status", "in": "query", "description": "Stored case status code, not the projected stage.code.", "schema": { "type": "string", "pattern": "^[a-z_]{1,64}$" } }, { "name": "after", "in": "query", "description": "Opaque cursor from the next link; preserve account and filters.", "schema": { "type": "string", "maxLength": 2048 } } ], "security": [ { "CanonicalSession": [] }, { "AccountOAuth": [ "cases:read" ] } ], "responses": { "200": { "description": "Own party memberships only. No Link header when there is no next page.", "headers": { "Link": { "description": "Relative next-page URI with rel=\"next\" when more memberships exist.", "schema": { "type": "string" }, "example": "; rel=\"next\"" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "cases": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "side": { "type": "string", "enum": [ "claimant", "respondent" ] }, "status": { "type": "string" }, "revision": { "type": "integer" } }, "required": [ "id", "side", "status", "revision" ] } } }, "required": [ "cases" ] } } } } } }, "422": { "description": "invalid_case_filter for invalid limit, side or status; invalid_case_cursor for an unavailable cursor or changed account or filters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountOAuthError" } } } } } }, "post": { "operationId": "createAccountCase", "summary": "Open a party filing through the hosted account contract", "tags": [ "Cases and participation" ], "description": "Flag-gated party filing through the existing account boundary. OAuth requires both filings:write and consents:write plus exact case acceptance. Tokens with standing bounds must instead accept a prepared packet through /api/authorizations/consents, preserving bounds, notice and opening-time revocation guards.", "security": [ { "CanonicalSession": [] }, { "AccountOAuth": [ "filings:write", "consents:write" ] } ], "responses": { "200": { "description": "Hosted creation result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "filingFeePending": { "type": "boolean" }, "feeChallenge": { "type": "object", "properties": { "method": { "type": "string" }, "feeRecordId": { "type": "string" }, "amountUsd": { "type": "number" }, "deadlineAt": { "type": "string" }, "checkoutEndpoint": { "type": "string" } } }, "track": { "type": "string" }, "respondentPreDisputeConsentAccepted": { "type": "boolean" }, "noticeQueued": { "type": "boolean" }, "noticeAddressMasked": { "type": "string" }, "idempotencyReplayed": { "type": "boolean" }, "capabilitiesReturned": { "type": "boolean" }, "claimantToken": { "type": "string" }, "inviteToken": { "type": "string" }, "invitePath": { "type": "string" } }, "required": [ "id", "status" ] } }, "required": [ "ok", "data" ] } } } }, "201": { "description": "Case created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "filingFeePending": { "type": "boolean" }, "feeChallenge": { "type": "object", "properties": { "method": { "type": "string" }, "feeRecordId": { "type": "string" }, "amountUsd": { "type": "number" }, "deadlineAt": { "type": "string" }, "checkoutEndpoint": { "type": "string" } } }, "track": { "type": "string" }, "respondentPreDisputeConsentAccepted": { "type": "boolean" }, "noticeQueued": { "type": "boolean" }, "noticeAddressMasked": { "type": "string" }, "idempotencyReplayed": { "type": "boolean" }, "capabilitiesReturned": { "type": "boolean" }, "claimantToken": { "type": "string" }, "inviteToken": { "type": "string" }, "invitePath": { "type": "string" } }, "required": [ "id", "status" ] } }, "required": [ "ok", "data" ] } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "flow": { "type": "string", "const": "party" }, "summary": { "type": "string" }, "backgroundFacts": { "type": "string" }, "governingLaw": { "type": "string", "enum": [ "platform_native", "common_law_contract", "custom_terms", "english_law", "singapore_law", "new_york_law", "delaware_law" ] }, "customTerms": { "type": "string" }, "disputeAmount": { "type": "number", "minimum": 0 }, "currency": { "type": "string" }, "escrowMode": { "type": "string", "enum": [ "simulation", "testnet", "mainnet", "none" ] }, "remedialJurisdictionOptIn": { "type": "boolean" }, "agree": { "type": "boolean", "const": true }, "track": { "type": "string", "enum": [ "standard", "fast", "agent" ] }, "hasPrincipal": { "type": "boolean" }, "principalCompressedClockConsent": { "type": "boolean" }, "feeMethod": { "type": "string", "const": "fiat_card" }, "claimant": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "human", "entity", "agent" ] }, "position": { "type": "string" }, "evidence": { "type": "array", "items": { "type": "string" } }, "relief": { "type": "string" }, "orderRelief": { "type": "string" }, "declaratoryRelief": { "type": "string" }, "walletAddress": { "type": "string" }, "webhookUrl": { "type": "string" }, "attest": { "type": "boolean", "const": true }, "declarantName": { "type": "string" }, "declarantCapacity": { "type": "string" }, "executionLocation": { "type": "string" } }, "required": [ "name", "position", "attest", "declarantName", "declarantCapacity", "executionLocation" ] }, "respondent": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "emailIsProper": { "type": "boolean" }, "emailSource": { "type": "string", "enum": [ "claimant_attested", "agreement", "notice_designation" ] } }, "required": [] }, "respondentPreDisputeConsent": { "type": "object", "description": "Existing pinned respondent ConsentAttestation, verified by the hosted filing operation." } }, "required": [ "flow", "summary", "governingLaw", "disputeAmount", "escrowMode", "claimant", "agree" ] } } } } } }, "/api/cases/{id}/messages": { "get": { "operationId": "listAccountCaseMessages", "summary": "Read authorized procedural message threads", "tags": [ "Party procedure" ], "description": "Flag-gated account operation over the existing hosted authorization boundary. Requires the approving account’s current party access. OAuth never grants administrator or reviewer authority. Typed channels retain separate hosted-thread and partner-notice authority and visibility. Partner writes require message:create and Idempotency-Key.", "security": [ { "CanonicalSession": [] }, { "AccountOAuth": [ "cases:read" ] }, { "CanonicalPartnerBearer": [] } ], "responses": { "200": { "description": "Authorized result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalListAccountCaseMessagesResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "schema": { "type": "string", "enum": [ "hosted_thread", "partner_notice" ] }, "description": "Partner bearer calls must select partner_notice. Account/session clients use hosted_thread; omission preserves existing account clients." } ] }, "post": { "operationId": "postAccountCaseMessage", "summary": "Post an authorized procedural message", "tags": [ "Party procedure" ], "description": "Flag-gated account operation over the existing hosted authorization boundary. Requires the approving account’s current party access. OAuth never grants administrator or reviewer authority. Typed channels retain separate hosted-thread and partner-notice authority and visibility. Partner writes require message:create and Idempotency-Key.", "security": [ { "CanonicalSession": [] }, { "AccountOAuth": [ "messages:write" ] }, { "CanonicalPartnerBearer": [] } ], "responses": { "200": { "description": "Reply committed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalPostAccountCaseMessageResponse" } } } }, "201": { "description": "Thread created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalPostAccountCaseMessageResponse" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "schema": { "type": "string", "enum": [ "hosted_thread", "partner_notice" ] }, "description": "Partner bearer calls must select partner_notice. Account/session clients use hosted_thread; omission preserves existing account clients." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalCaseMessageInput" } } } } }, "patch": { "operationId": "closeAccountCaseMessage", "summary": "Close an authorized procedural message thread", "tags": [ "Party procedure" ], "description": "Flag-gated account operation over the existing hosted authorization boundary. Requires the approving account’s current party access. OAuth never grants administrator or reviewer authority.", "security": [ { "CanonicalSession": [] }, { "AccountOAuth": [ "messages:write" ] } ], "responses": { "200": { "description": "Authorized result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "data": { "$ref": "#/components/schemas/CanonicalHostedThreadResult" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "schema": { "type": "string", "enum": [ "hosted_thread", "partner_notice" ] }, "description": "Partner bearer calls must select partner_notice. Account/session clients use hosted_thread; omission preserves existing account clients." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "threadId": { "type": "string" } }, "required": [ "threadId" ] } } } } } }, "/api/cases/{id}/evaluation": { "get": { "security": [ { "platformOrchestratorBearer": [] }, { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Evaluation" ], "operationId": "getEvaluationCanonical", "summary": "Read the immutable evaluation definition and any served result", "description": "Returns pending or review state until an Award is served. A served result maps only to the three outcomes authorized in the evaluation draft.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/PartyToken" } ], "responses": { "200": { "description": "Narrow evaluation state and result projection.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/NarrowEvaluationResource" }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-preview": true } }, "/api/cases/{id}/evaluation/accept": { "post": { "security": [ { "respondentAgentBearer": [] } ], "tags": [ "Evaluation" ], "operationId": "acceptEvaluationCanonical", "summary": "Accept a claimant-proposed narrow evaluation", "description": "Redeems the one-time respondent invitation and binds the respondent to the exact evaluation digest before evidence opens. Idempotency is resolved before mutable invitation/case-state validation: the same key and body replay the stored 201 without the show-once capability, while a different body returns idempotency_conflict.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NarrowEvaluationAcceptanceInput" } } } }, "responses": { "201": { "description": "Evaluation accepted; the respondent party capability is returned once.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/NarrowEvaluationAcceptance" }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-preview": true } }, "/api/cases/{id}/settlement-binding": { "post": { "security": [ { "platformOrchestratorBearer": [] } ], "tags": [ "Execution" ], "operationId": "registerSettlementBindingCanonical", "summary": "Bind a case to one external settlement corpus", "description": "A platform orchestrator registers the USD-only binding only after bilateral authorization and while the dispute is in awaiting_submissions or awaiting_validation, with no Award. The server atomically checks the current dispute revision/status, derives immutable actor and authority-grant metadata, and binds that metadata with the evaluation digest, action subset, participant identities, adapter, and corpus limits. An exact idempotent replay remains valid after the registration window closes.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerSettlementBindingInput" } } } }, "responses": { "201": { "description": "Immutable settlement binding created or idempotently replayed.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/PartnerSettlementBinding" }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-preview": true }, "get": { "security": [ { "platformOrchestratorBearer": [] }, { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Execution" ], "operationId": "getSettlementBindingCanonical", "summary": "Read the case's settlement binding", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Digest-bound settlement binding.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/PartnerSettlementBinding" }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-preview": true } }, "/api/cases/{id}/settlement-executions": { "post": { "security": [ { "settlementAdapterBearer": [] }, { "CanonicalPartnerBearer": [] }, { "CanonicalSession": [] }, { "AccountOAuth": [ "executions:report" ] } ], "tags": [ "Execution" ], "operationId": "executeSettlementCanonical", "summary": "Validate or execute the authorized settlement action", "description": "Requires a credential with the dedicated settlement:execute capability bound to the exact adapter. The action is derived from the served evaluation outcome, never supplied by the caller. Dry runs append a validated receipt; live calls append an immutable caller attempt linked to one server-derived business-operation journal. Different caller idempotency keys cannot resubmit the same binding, operative Award revision/hash, and action. Unknown provider outcomes require reconciliation before any terminal result is reported.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PartnerSettlementExecutionInput" }, { "$ref": "#/components/schemas/AwardExecutionCommand" } ] } } } }, "responses": { "201": { "description": "Legacy digest input returns an immutable attempt; action input returns the canonical Award execution resource.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/PartnerSettlementAttempt" }, { "$ref": "#/components/schemas/AwardExecutionResource" } ] }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-preview": true }, "get": { "security": [ { "settlementAdapterBearer": [] } ], "tags": [ "Execution" ], "operationId": "getSettlementExecutionsCanonical", "summary": "List settlement attempts and business operations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "view", "in": "query", "required": false, "description": "Select executions for the four-mode Award resource; omission preserves the legacy attempts response.", "schema": { "type": "string", "enum": [ "executions" ] } } ], "responses": { "200": { "description": "Immutable caller attempts and the authoritative business-operation journal.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "oneOf": [ { "type": "object", "required": [ "caseId", "executions" ], "properties": { "caseId": { "type": "string" }, "executions": { "type": "array", "items": { "$ref": "#/components/schemas/AwardExecutionResource" } } } }, { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "caseId", "attempts", "operations" ], "properties": { "schemaVersion": { "type": "string", "const": "partner-settlement-attempt-list-v2" }, "caseId": { "type": "string" }, "attempts": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerSettlementAttempt" } }, "operations": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerSettlementOperation" } } } } ] }, "requestId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-preview": true } }, "/api/rules/current": { "get": { "security": [], "tags": [ "Discovery" ], "operationId": "getCurrentRulesCanonical", "summary": "Read the current Rules and public procedure metadata", "responses": { "200": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalGetCurrentRulesCanonicalResponse" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "parameters": [ { "name": "x-pc-compatibility", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "v1" ] }, "description": "Bounded compatibility inputs on the canonical URL. Existing scoped credentials retain v1 responses; role-bound credentials use grant-checked typed operations. Preserves each contract’s original journals, consent and disclosure. See /openapi/partner-v1.json for scoped credentials." } ], "x-compatibility-contract": "v1", "x-preview": true } }, "/api/cases/{id}/award": { "get": { "security": [ { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Decision and remedies" ], "operationId": "getServedAwardCanonical", "summary": "Read the served Award", "description": "Returns the deterministic public decision projection derived from the immutable signed award-decision-v2 revision, never a mutable live disposition. It contains no internal dispute ID and no recipe-v3 manifest or verification envelope. Known internal IDs are replaced even when embedded in strings; every recognized money key must be numeric internally, null, or exact FiatMoney, every present amounts field must be an exact-money array, and malformed values or residual internal-ID patterns fail closed. companionArtifacts advertises PDF, DOCX, and canonical award-decision-v2 JSON descriptors through a closed-schema, separately signed, public-case-bound companion attestation.", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/PartyToken" }, { "name": "x-pc-compatibility", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "v1" ] }, "description": "Bounded compatibility inputs on the canonical URL. Existing scoped credentials retain v1 responses; role-bound credentials use grant-checked typed operations. Preserves each contract’s original journals, consent and disclosure. See /openapi/partner-v1.json for scoped credentials." } ], "responses": { "200": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalGetServedAwardCanonicalResponse" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-contract": "v1", "x-preview": true } }, "/api/cases/{id}/award/artifacts/{kind}": { "get": { "security": [ { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Decision and remedies" ], "operationId": "downloadAwardArtifactCanonical", "summary": "Download an exact served Award artifact", "description": "PDF and DOCX retain their frozen source bytes and JSON is a separately persisted canonical award-decision-v2 exact-money derivative. The public v2 response omits the internal-identity-bearing recipe-v3 envelope. Verify every download through the signed companion attestation, which binds public case IDs, derivative artifact identity and bytes, source Award hash/disposition/revision, and all three source descriptors.", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/PartyToken" }, { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "pdf", "docx", "json" ] } } ], "responses": { "200": { "description": "Exact served award bytes." }, "default": { "$ref": "#/components/responses/Problem" } }, "x-preview": true } }, "/api/cases/{id}/award/artifacts/json/attestation": { "get": { "security": [ { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Decision and remedies" ], "operationId": "getAwardJsonAttestationCanonical", "summary": "Read the signed v2 JSON Award companion attestation", "description": "Returns the separately signed public-case-bound derivative attestation and exact PDF/DOCX/JSON source descriptor set. The attestation is a closed schema, so undeclared fields fail verification. The recipe-v3 bytes remain unchanged in v1 storage but its internal-identity-bearing manifest and verification envelope are not exposed by v2.", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/PartyToken" } ], "responses": { "200": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalGetAwardJsonAttestationCanonicalResponse" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-preview": true } }, "/api/cases/{id}/record-bundle": { "get": { "security": [ { "claimantAgentBearer": [] }, { "respondentAgentBearer": [] } ], "tags": [ "Case record" ], "operationId": "getCaseRecordBundleManifestCanonical", "summary": "Download a v2 party record manifest or full verified bundle", "description": "Both forms use the isolated case-record-bundle-v2 identity and exact-money canonical JSON. Manifest responses and full bundles carry a signed v2 attestation binding partner, public case IDs, side, revision, Rules, bundle identity, and every file digest. Verification scans the entire canonical artifact for internal IDs and requires case, docket, messages, applicable decisions, and a validated award-decision-v2 plus matching trusted attestation for every required revision; filenames alone never establish completeness. The opaque sourceSnapshotHash supports deterministic cache identity without exposing any v1 source bundle ID; no recipe-v3 envelope, v1 bundle ID, or v1 cache row is exposed or reused.", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/PartyToken" }, { "name": "format", "in": "query", "schema": { "type": "string", "enum": [ "manifest", "bundle" ], "default": "manifest" } }, { "name": "x-pc-compatibility", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "v1" ] }, "description": "Bounded compatibility inputs on the canonical URL. Existing scoped credentials retain v1 responses; role-bound credentials use grant-checked typed operations. Preserves each contract’s original journals, consent and disclosure. See /openapi/partner-v1.json for scoped credentials." } ], "responses": { "200": { "description": "Party record integrity manifest envelope or canonical full bundle bytes.", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "data": { "type": "object", "properties": { "artifactSha256": { "type": "string" }, "byteLength": { "type": "integer" }, "verification": { "type": "object", "properties": { "ok": { "const": true }, "mode": { "type": "string", "enum": [ "persisted_snapshot_reuse", "verified_at_creation" ] }, "bundleId": { "type": "string" }, "bundleHash": { "type": "string" } } }, "caseId": { "type": "string" }, "externalCaseId": { "type": "string" }, "manifest": { "$ref": "#/components/schemas/PartnerCaseRecordBundleManifest" }, "attestation": { "$ref": "#/components/schemas/PartnerCaseRecordBundleAttestation" } }, "required": [ "caseId", "externalCaseId", "manifest", "attestation", "artifactSha256", "byteLength", "verification" ] }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ] }, { "type": "object", "properties": { "ok": { "const": true }, "data": { "type": "object", "properties": { "artifactSha256": { "type": "string" }, "byteLength": { "type": "integer" }, "verification": { "type": "object", "properties": { "ok": { "const": true }, "mode": { "type": "string", "enum": [ "persisted_snapshot_reuse", "verified_at_creation" ] }, "bundleId": { "type": "string" }, "bundleHash": { "type": "string" } } }, "manifest": { "$ref": "#/components/schemas/CanonicalHostedRecordBundleManifest" } }, "required": [ "manifest", "artifactSha256", "byteLength", "verification" ] } }, "required": [ "ok", "data" ] } ] } }, "application/vnd.peoples-court.case-record-bundle-v2+json": { "schema": { "type": "string", "format": "binary" }, "description": "Immutable full bundle bytes. Request format=bundle and verify the manifest and byte digest." }, "application/vnd.peoplescourt.case-record+json": { "schema": { "type": "string", "format": "binary" }, "description": "Immutable full bundle bytes. Request format=bundle and verify the manifest and byte digest." } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-contract": "v1", "x-preview": true } }, "/api/fees/quotes": { "get": { "operationId": "quoteFilingFeeCanonical", "tags": [ "Fees" ], "summary": "Quote the current filing fee using exact USD minor units", "security": [], "parameters": [ { "name": "currency", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "USD" ] }, "description": "Required when the compatibility header is absent." }, { "name": "minorUnits", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(0|[1-9][0-9]{0,77})$" }, "description": "Required when the compatibility header is absent." }, { "name": "declaratoryOnly", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "x-pc-compatibility", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "v1" ] }, "description": "Bounded compatibility inputs on the canonical URL. Existing scoped credentials retain v1 responses; role-bound credentials use grant-checked typed operations. Preserves each contract’s original journals, consent and disclosure. See /openapi/partner-v1.json for scoped credentials." }, { "name": "amount", "in": "query", "schema": { "type": "number", "minimum": 0 }, "description": "USD amount, required only with x-pc-compatibility: v1." } ], "responses": { "200": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalQuoteFilingFeeCanonicalResponse" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "x-compatibility-contract": "v1", "x-preview": true } }, "/api/fees/{feeId}": { "get": { "operationId": "readFeePreview", "tags": [ "Fees" ], "summary": "Read an authorized fee by its durable id", "description": "Controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. Projects the exact amount, status, applicable case, collection disposition and expiry of one fee record for an authorized case party. Provider attempt internals and transaction references stay internal, and no party-supplied paid flag is ever trusted.", "security": [ { "CanonicalSession": [] }, { "CanonicalPartnerBearer": [] }, { "AccountOAuth": [ "cases:read" ] } ], "parameters": [ { "name": "feeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authorized fee resource.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/CanonicalFee" }, "requestId": { "type": "string" } } } } } }, "404": { "description": "Preview disabled, or no fee this caller may read." }, "default": { "$ref": "#/components/responses/Problem" } }, "x-preview": true } }, "/api/fees/{feeId}/checkout": { "post": { "operationId": "startFeeCheckoutPreview", "tags": [ "Fees" ], "summary": "Initiate payment for one fee, provider-neutrally", "description": "Controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. The fee is selected by the resource path; the existing checkout operation keeps its authority, sponsorship-coverage, rate-limit and fee-intent identity checks, so an equivalent retry returns the same provider intent instead of creating a second one. A card fee returns a Stripe Checkout session; an x402 fee returns the exact payment requirements committed when the fee was quoted, still confirmed by its own signed machine route.", "security": [ { "CanonicalSession": [] }, { "CanonicalPartnerBearer": [] }, { "AccountOAuth": [ "remedies:write" ] } ], "parameters": [ { "name": "feeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalFeeCheckoutInput" } } } }, "responses": { "200": { "description": "Typed checkout descriptor for the selected provider.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/CanonicalFeeCheckout" }, "requestId": { "type": "string" } } } } } }, "404": { "description": "Preview disabled, or no fee this caller may pay." }, "default": { "$ref": "#/components/responses/Problem" } }, "x-preview": true } }, "/api/cases/{id}/submissions/{submissionId}": { "patch": { "operationId": "amendSubmissionPreview", "tags": [ "Case record" ], "summary": "Amend a filing where pinned Rules permit", "description": "Controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. The shared operation rechecks current authority and pinned Rules. Historical administrator-only amendment boundaries remain unchanged; a bearer grant does not authorize administration.", "security": [ { "CanonicalSession": [] }, { "CanonicalPartnerBearer": [] }, { "AccountOAuth": [ "submissions:write" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "submissionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Reuse across compatibility and canonical aliases to recover the same committed act. Changed typed input conflicts." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalAmendmentForm" } }, "multipart/form-data": { "schema": { "type": "object", "properties": { "brief": { "type": "string" }, "reason": { "type": "string" }, "files": { "type": "array", "items": { "type": "string", "format": "binary" } } } } } } }, "responses": { "200": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalAmendSubmissionPreviewResponse" } } } }, "404": { "description": "Preview disabled or authorized resource unavailable." }, "default": { "$ref": "#/components/responses/Problem" } }, "x-preview": true } }, "/api/cases/{id}/submissions/{submissionId}/replacements": { "post": { "operationId": "fileReplacementPreview", "tags": [ "Case record" ], "summary": "File a Rule 4.7 replacement or response", "description": "Controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. The shared operation rechecks current authority and pinned Rules. Requires submission:create for a partner and the current own-side Rule 4.7 window.", "security": [ { "CanonicalSession": [] }, { "CanonicalPartnerBearer": [] }, { "AccountOAuth": [ "submissions:write" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "submissionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Reuse across compatibility and canonical aliases to recover the same committed act. Changed typed input conflicts." }, { "name": "kind", "in": "query", "schema": { "type": "string", "enum": [ "replacement", "response" ], "default": "replacement" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CanonicalReplacementForm" } } } }, "responses": { "201": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalFileReplacementPreviewResponse" } } } }, "404": { "description": "Preview disabled or authorized resource unavailable." }, "default": { "$ref": "#/components/responses/Problem" } }, "x-preview": true } }, "/api/cases/{id}/evidence/{evidenceId}": { "get": { "operationId": "readEvidenceFilePreview", "tags": [ "Case record" ], "summary": "Download an authorized original evidence file", "description": "Controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. The shared operation rechecks current authority and pinned Rules. Supports Range and never reveals a sealed opponent file.", "security": [ { "CanonicalSession": [] }, { "CanonicalPartnerBearer": [] }, { "AccountOAuth": [ "cases:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "evidenceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Range", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Original source bytes.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "206": { "description": "Requested byte range." }, "404": { "description": "Preview disabled or authorized resource unavailable." }, "default": { "$ref": "#/components/responses/Problem" } }, "x-preview": true } }, "/api/cases/{id}/representatives": { "get": { "operationId": "listRepresentativesPreview", "tags": [ "Party procedure" ], "summary": "List representatives for the authorized side", "description": "Controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. The shared operation rechecks current authority and pinned Rules. Partner writes require representatives:manage and are confined to the membership side. Existing grants gain no authority. Invitation replay returns invitationEmail: not_repeated without sending another email.", "security": [ { "CanonicalSession": [] }, { "CanonicalPartnerBearer": [] }, { "AccountOAuth": [ "cases:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalListRepresentativesPreviewResponse" } } } }, "404": { "description": "Preview disabled or authorized resource unavailable." }, "default": { "$ref": "#/components/responses/Problem" } }, "x-preview": true }, "post": { "operationId": "inviteRepresentativePreview", "tags": [ "Party procedure" ], "summary": "Invite a representative for the acting party", "description": "Controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. The shared operation rechecks current authority and pinned Rules. Partner writes require representatives:manage and are confined to the membership side. Existing grants gain no authority. Invitation replay returns invitationEmail: not_repeated without sending another email.", "security": [ { "CanonicalSession": [] }, { "CanonicalPartnerBearer": [] }, { "AccountOAuth": [ "representatives:manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Reuse across compatibility and canonical aliases to recover the same committed act. Changed typed input conflicts." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepresentativeInvitationPreview" } } } }, "responses": { "201": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalInviteRepresentativePreviewResponse" } } } }, "404": { "description": "Preview disabled or authorized resource unavailable." }, "default": { "$ref": "#/components/responses/Problem" } }, "x-preview": true }, "patch": { "operationId": "updateRepresentativePreview", "tags": [ "Party procedure" ], "summary": "Act on a representative appointment", "description": "Controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. The shared operation rechecks current authority and pinned Rules. Partner writes require representatives:manage and are confined to the membership side. Existing grants gain no authority. Invitation replay returns invitationEmail: not_repeated without sending another email.", "security": [ { "CanonicalSession": [] }, { "CanonicalPartnerBearer": [] }, { "AccountOAuth": [ "representatives:manage" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Reuse across compatibility and canonical aliases to recover the same committed act. Changed typed input conflicts." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepresentativeChangePreview" } } } }, "responses": { "200": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalUpdateRepresentativePreviewResponse" } } } }, "404": { "description": "Preview disabled or authorized resource unavailable." }, "default": { "$ref": "#/components/responses/Problem" } }, "x-preview": true } }, "/api/cases/{id}/procedural-requests": { "get": { "operationId": "listProceduralRequestsPreview", "tags": [ "Party procedure" ], "summary": "Read shared procedural requests", "description": "Controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. The shared operation rechecks current authority and pinned Rules. Partner writes require procedural:request. This grants neither general hosted-message access nor ruling authority.", "security": [ { "CanonicalSession": [] }, { "CanonicalPartnerBearer": [] }, { "AccountOAuth": [ "cases:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalListProceduralRequestsPreviewResponse" } } } }, "404": { "description": "Preview disabled or authorized resource unavailable." }, "default": { "$ref": "#/components/responses/Problem" } }, "x-preview": true }, "post": { "operationId": "fileProceduralRequestPreview", "tags": [ "Party procedure" ], "summary": "File a party procedural request", "description": "Controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. The shared operation rechecks current authority and pinned Rules. Partner writes require procedural:request. This grants neither general hosted-message access nor ruling authority.", "security": [ { "CanonicalSession": [] }, { "CanonicalPartnerBearer": [] }, { "AccountOAuth": [ "procedural:request" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Reuse across compatibility and canonical aliases to recover the same committed act. Changed typed input conflicts." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProceduralRequestPreview" } } } }, "responses": { "201": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalFileProceduralRequestPreviewResponse" } } } }, "404": { "description": "Preview disabled or authorized resource unavailable." }, "default": { "$ref": "#/components/responses/Problem" } }, "x-preview": true } }, "/api/cases/{id}/termination-requests": { "post": { "operationId": "requestTerminationPreview", "tags": [ "Party procedure" ], "summary": "Request or cancel termination", "description": "Controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. The shared operation rechecks current authority and pinned Rules. Partner calls require case:terminate, expectedRevision and Idempotency-Key; existing termination journal and adoption rules are preserved.", "security": [ { "CanonicalSession": [] }, { "CanonicalPartnerBearer": [] }, { "AccountOAuth": [ "termination:write" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Reuse across compatibility and canonical aliases to recover the same committed act. Changed typed input conflicts." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TerminationRequestInput" } } } }, "responses": { "201": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalRequestTerminationPreviewResponse" } } } }, "404": { "description": "Preview disabled or authorized resource unavailable." }, "default": { "$ref": "#/components/responses/Problem" } }, "x-preview": true } }, "/api/cases/{id}/termination-requests/{requestId}/confirmations": { "post": { "operationId": "confirmTerminationPreview", "tags": [ "Party procedure" ], "summary": "Confirm a pending termination request", "description": "Controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. The shared operation rechecks current authority and pinned Rules. The request ID is bound by the path. Partner calls require case:terminate and Idempotency-Key.", "security": [ { "CanonicalSession": [] }, { "CanonicalPartnerBearer": [] }, { "AccountOAuth": [ "termination:write" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Reuse across compatibility and canonical aliases to recover the same committed act. Changed typed input conflicts." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalTerminationConfirmationInput" } } } }, "responses": { "201": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalConfirmTerminationPreviewResponse" } } } }, "404": { "description": "Preview disabled or authorized resource unavailable." }, "default": { "$ref": "#/components/responses/Problem" } }, "x-preview": true } }, "/api/cases/{id}/withdrawals": { "post": { "operationId": "withdrawClaimPreview", "tags": [ "Party procedure" ], "summary": "Withdraw a claim where pinned Rules permit", "description": "Controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. The shared operation rechecks current authority and pinned Rules. Confined to an authorized claimant and the existing unilateral-withdrawal predicate.", "security": [ { "CanonicalSession": [] }, { "CanonicalPartnerBearer": [] }, { "AccountOAuth": [ "termination:write" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Reuse across compatibility and canonical aliases to recover the same committed act. Changed typed input conflicts." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TerminationRequestInput" } } } }, "responses": { "201": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalWithdrawClaimPreviewResponse" } } } }, "404": { "description": "Preview disabled or authorized resource unavailable." }, "default": { "$ref": "#/components/responses/Problem" } }, "x-preview": true } }, "/api/filings/{id}/agent-consents": { "get": { "tags": [ "Filing confirmations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "AccountOAuth": [ "consents:write" ] } ], "responses": { "200": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalGetAgentOnlyConsentPacketResponse" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "operationId": "getAgentOnlyConsentPacket", "summary": "Read this verified principal’s exact Agent-only acceptance statement", "description": "Only the bound, registered autonomous-agent account can read its side-specific statement. Partner representative credentials and standing grants cannot authorize this operation." }, "post": { "tags": [ "Filing confirmations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "AccountOAuth": [ "consents:write" ] } ], "responses": { "200": { "description": "Authorized operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanonicalAcceptAgentOnlyFilingResponse" } } } }, "default": { "$ref": "#/components/responses/Problem" } }, "operationId": "acceptAgentOnlyFiling", "summary": "Accept Agent-only procedure as the verified principal", "description": "Exact packet digest and side-specific statement required. Both principals must accept independently before a representative can open the case. Acceptance and OAuth/account guards commit atomically.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "termsDigest", "acceptanceStatement" ], "properties": { "termsDigest": { "type": "string" }, "acceptanceStatement": { "type": "string" } } } } } } } }, "/api/cases/{id}/ai-configuration-challenges": { "post": { "operationId": "fileHistoricalAiConfigurationChallengeCanonical", "tags": [ "Party procedure" ], "summary": "File a challenge under the case-pinned historical AI-configuration procedure", "description": "Only a case-bound party or authorized representative may file. Current Rules reject this historical procedure. The response retains the hosted ok/data or ok/error/code envelope. Administrative resolution remains an internal restricted act.", "security": [ { "CanonicalSession": [] }, { "AccountOAuth": [ "procedural:request" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "expectedRevision", "concern" ], "properties": { "expectedRevision": { "type": "integer" }, "concern": { "type": "string", "enum": [ "provider_is_party", "operator_is_party", "developer_is_party", "controlling_affiliate_is_party", "direct_material_economic_interest", "material_subject_integrity_risk", "data_incompatibility", "integrity_defect", "configuration_unavailable", "generic_ai" ] }, "detail": { "type": "string" } } } } } }, "responses": { "201": { "description": "Challenge stored under the pinned historical procedure.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "data": { "type": "object", "properties": { "status": { "const": "committed" }, "dispute": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "revision": { "type": "integer" }, "aiConfigurationChallenges": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "concern": { "type": "string" }, "detail": { "type": "string" }, "filedBySide": { "type": "string", "enum": [ "claimant", "respondent" ] }, "filedAt": { "type": "string" }, "status": { "type": "string" }, "statusBeforeHold": { "type": "string" }, "suspendedRunIds": { "type": "array", "items": { "type": "string" } }, "resolution": { "type": "object", "properties": { "at": { "type": "string" }, "actorLabel": { "type": "string" }, "reasons": { "type": "string" }, "replacementSelected": { "type": "boolean" } } } } } } } }, "challenge": { "type": "object", "properties": { "id": { "type": "string" }, "concern": { "type": "string" }, "detail": { "type": "string" }, "filedBySide": { "type": "string", "enum": [ "claimant", "respondent" ] }, "filedAt": { "type": "string" }, "status": { "type": "string" }, "statusBeforeHold": { "type": "string" }, "suspendedRunIds": { "type": "array", "items": { "type": "string" } }, "resolution": { "type": "object", "properties": { "at": { "type": "string" }, "actorLabel": { "type": "string" }, "reasons": { "type": "string" }, "replacementSelected": { "type": "boolean" } } } } } }, "required": [ "status", "dispute", "challenge" ] } }, "required": [ "ok", "data" ] } } } }, "default": { "description": "Unchanged hosted error envelope; authority, revision and historical Rules restrictions apply.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": false }, "error": { "type": "string" }, "code": { "type": "string" } } } } } } } } }, "/api/cases/{id}/stripe-connect-binding": { "get": { "operationId": "getStripeConnectBinding", "tags": [ "Execution" ], "summary": "Read the immutable Stripe connected-account binding", "security": [ { "CanonicalPartnerBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authorized Stripe Connect resource.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "required": [ "caseId", "binding" ], "properties": { "caseId": { "type": "string" }, "binding": { "anyOf": [ { "$ref": "#/components/schemas/StripeConnectBinding" }, { "type": "null" } ] } } }, "requestId": { "type": "string" } } } } } }, "default": { "description": "Authorization, validation or provider configuration failure.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "post": { "operationId": "bindStripeConnectAccounts", "tags": [ "Execution" ], "summary": "Bind linked payer and payee accounts before Award preparation", "description": "Requires the settlement_adapter role scoped to stripe_connect. Both accounts belong to this tenant. Express debit consent, exact USD amount and party mapping become immutable binding identity. No money is moved by this operation.", "security": [ { "CanonicalPartnerBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "payerConnectedAccountId", "payeeConnectedAccountId", "payerSide", "amountUsd", "debitConsentReference", "authorizeAccountDebit" ], "properties": { "payerConnectedAccountId": { "type": "string", "pattern": "^acct_[a-zA-Z0-9]+$", "example": "acct_payerExample" }, "payeeConnectedAccountId": { "type": "string", "pattern": "^acct_[a-zA-Z0-9]+$", "example": "acct_payeeExample" }, "payerSide": { "enum": [ "claimant", "respondent" ] }, "amountUsd": { "type": "number", "exclusiveMinimum": 0, "multipleOf": 0.01 }, "debitConsentReference": { "type": "string", "minLength": 1, "maxLength": 200 }, "authorizeAccountDebit": { "const": true } } } } } }, "responses": { "200": { "description": "Authorized Stripe Connect resource.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "required": [ "caseId", "binding" ], "properties": { "caseId": { "type": "string" }, "binding": { "anyOf": [ { "$ref": "#/components/schemas/StripeConnectBinding" }, { "type": "null" } ] } } }, "requestId": { "type": "string" } } } } } }, "201": { "description": "Authorized Stripe Connect resource.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "required": [ "caseId", "binding" ], "properties": { "caseId": { "type": "string" }, "binding": { "anyOf": [ { "$ref": "#/components/schemas/StripeConnectBinding" }, { "type": "null" } ] } } }, "requestId": { "type": "string" } } } } } }, "default": { "description": "Authorization, validation or provider configuration failure.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/account/integrations/{partnerId}/stripe-connect": { "get": { "operationId": "listConsoleStripeConnectedAccounts", "tags": [ "Execution" ], "summary": "Read the administrator’s tenant connected-account status", "security": [ { "CanonicalSession": [] } ], "parameters": [ { "name": "partnerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authorized Stripe Connect resource.", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "data" ], "properties": { "data": { "type": "object", "required": [ "configured", "accounts" ], "properties": { "configured": { "type": "boolean" }, "accounts": { "type": "array", "items": { "$ref": "#/components/schemas/StripeConnectedAccount" } } } }, "ok": { "type": "boolean" } } } } } }, "default": { "description": "Authorization, validation or provider configuration failure.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-mcp-exposure": "none" }, "post": { "operationId": "createConsoleStripeOnboardingLink", "tags": [ "Execution" ], "summary": "Admit or resume Stripe account onboarding for a tenant", "description": "An active tenant administrator and current account session are required. Return and refresh URLs are fixed by APP_URL. A single-use URL is returned once and never stored. The request is checked at the storage commit before provider account creation.", "security": [ { "CanonicalSession": [] } ], "parameters": [ { "name": "partnerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "accountRecordId": { "type": "string" } } } } } }, "responses": { "201": { "description": "Authorized Stripe Connect resource.", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "data" ], "properties": { "data": { "type": "object", "required": [ "account", "onboardingUrl", "expiresAt" ], "properties": { "account": { "$ref": "#/components/schemas/StripeConnectedAccount" }, "onboardingUrl": { "type": "string", "format": "uri" }, "expiresAt": { "type": "string", "format": "date-time" } } }, "ok": { "type": "boolean" } } } } } }, "default": { "description": "Authorization, validation or provider configuration failure.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-mcp-exposure": "none" } }, "/api/cases/{id}/executions": { "get": { "operationId": "listAwardExecutions", "tags": [ "Execution" ], "summary": "Read execution resources for all four modes", "security": [ { "CanonicalPartnerBearer": [] }, { "CanonicalSession": [] }, { "AccountOAuth": [ "cases:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authorized execution records with honest payment and provenance facts.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "required": [ "caseId", "executions" ], "properties": { "caseId": { "type": "string" }, "executions": { "type": "array", "items": { "$ref": "#/components/schemas/AwardExecutionResource" } } } }, "requestId": { "type": "string" } } } } } }, "default": { "description": "Authorization, validation, or execution conflict.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "post": { "operationId": "recordAwardExecution", "tags": [ "Execution" ], "summary": "Request execution or record performance and partner follow-up", "description": "Reports require active case membership. OAuth requires the new executions:report scope; existing grants gain no authority. Acknowledgement or dispute comes from the opposite side. Provider release requires a separately authorized settlement adapter credential and all Award holds to clear. Partner receipts and non-execution attestations additionally require x-execution-timestamp and x-execution-signature. The HMAC-SHA256 key is the presented partner bearer credential; sign canonical JSON of caseId, awardHash, idempotencyKey, timestamp and body. Timestamp is Unix milliseconds, within five minutes. A signature proves report provenance; the registered partner provider independently verifies a receipt. Idempotency and the Award journal are shared with settlement-executions aliases.", "security": [ { "CanonicalPartnerBearer": [] }, { "CanonicalSession": [] }, { "AccountOAuth": [ "executions:report" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "x-execution-timestamp", "in": "header", "schema": { "type": "string" } }, { "name": "x-execution-signature", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AwardExecutionCommand" } } } }, "responses": { "201": { "description": "Recorded execution resource or authorized replay.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/AwardExecutionResource" }, "requestId": { "type": "string" } } } } } }, "default": { "description": "Authorization, validation, or execution conflict.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/executions/{id}": { "get": { "operationId": "getAwardExecution", "tags": [ "Execution" ], "summary": "Read one execution and its receipts or performance reports", "security": [ { "CanonicalPartnerBearer": [] }, { "CanonicalSession": [] }, { "AccountOAuth": [ "cases:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authorized execution resource.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/AwardExecutionResource" }, "requestId": { "type": "string" } } } } } }, "default": { "description": "Authorization, validation, or execution conflict.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/sandbox/{partnerId}/cases": { "get": { "operationId": "listPartnerSandboxCases", "tags": [ "Integration sandbox" ], "summary": "Read isolated synthetic stage samples", "description": "Uses a separate sandbox credential issued once in the partner console. Ordinary partner and live credentials are refused. Reset invalidates the previous sandbox credential. Samples are not filed proceedings or signed Awards and cannot call providers or complete integration milestones. The workflow field points to npm run sandbox:partner and its --demo option, which run a separate local synthetic canonical workflow. It does not advertise a hosted mutation or control endpoint.", "security": [ { "PartnerSandboxBearer": [] } ], "parameters": [ { "name": "partnerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The current synthetic sandbox generation.", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "data" ], "properties": { "ok": { "const": true }, "data": { "$ref": "#/components/schemas/PartnerIntegrationSandbox" } } } } } }, "default": { "description": "Sandbox credential, tenant status or rate-limit refusal.", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "string" } } } } } } } } } }, "webhooks": { "caseNotification": { "post": { "tags": [ "Webhooks" ], "operationId": "receivePartnerCaseNotificationV2", "summary": "Receive a sparse informational case event", "description": "Delivered at least once. Verify the Ed25519 signature, deduplicate by eventId across deliveryId values, use sequence only as an ordering cursor, acknowledge promptly, and fetch authoritative state before acting.", "parameters": [ { "$ref": "#/components/parameters/ContentDigest" }, { "$ref": "#/components/parameters/PcEventId" }, { "$ref": "#/components/parameters/PcEventTimestamp" }, { "$ref": "#/components/parameters/PcKeyId" }, { "$ref": "#/components/parameters/CaseEventSchemaVersion" }, { "$ref": "#/components/parameters/PcSignatureVersion" }, { "$ref": "#/components/parameters/PcSignature" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "eventId", "deliveryId", "sequence", "type", "occurredAt", "caseId", "externalCaseId", "actionRequired" ], "properties": { "schemaVersion": { "type": "string", "const": "case-event-v2" }, "eventId": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,160}$" }, "deliveryId": { "type": "string" }, "sequence": { "type": "integer", "minimum": 1 }, "type": { "type": "string" }, "occurredAt": { "type": "string", "format": "date-time", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\\.[0-9]{3}Z$" }, "caseId": { "type": "string" }, "externalCaseId": { "type": "string" }, "actionRequired": { "type": "boolean" }, "deadlineAt": { "type": "string", "format": "date-time", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\\.[0-9]{3}Z$" }, "caseEvent": { "$ref": "#/components/schemas/CanonicalCaseEvent" } } } } } }, "responses": { "204": { "description": "Event accepted." } } } } }, "components": { "headers": { "EvidenceNotificationTraceId": { "description": "Fresh server-generated correlation ID for this notification-route invocation, including failures and replays. Incoming x-pc-trace-id is ignored. Separate from the existing caller-compatible requestId; retain this response header when reporting a rejected request. It identifies an invocation, not a receipt or proof of durable log retention. Responses generated before the route runs may omit it.", "schema": { "type": "string", "pattern": "^trace_[0-9a-f-]{36}$" } } }, "securitySchemes": { "PartnerSandboxBearer": { "type": "http", "scheme": "bearer", "bearerFormat": "sb_test_.", "description": "Isolated sandbox credential; never accepted by the ordinary Partner API." }, "CanonicalPartnerBearer": { "type": "http", "scheme": "bearer" }, "CanonicalSession": { "type": "apiKey", "in": "cookie", "name": "arb_session" }, "platformOrchestratorBearer": { "type": "http", "scheme": "bearer", "description": "Credential bound to the platform_orchestrator role." }, "claimantAgentBearer": { "type": "http", "scheme": "bearer", "description": "Credential bound to the claimant_agent role. Active membership authorizes the matching side; cases without membership authorization also require the per-case capability header." }, "respondentAgentBearer": { "type": "http", "scheme": "bearer", "description": "Credential bound to the respondent_agent role. Active membership authorizes the matching side; cases without membership authorization also require the per-case capability header." }, "evidenceExporterBearer": { "type": "http", "scheme": "bearer", "description": "Credential bound to one evidence_exporter resource." }, "settlementAdapterBearer": { "type": "http", "scheme": "bearer", "description": "Credential carrying only settlement:execute and bound to one exact adapter resource." }, "readOnlyObserverBearer": { "type": "http", "scheme": "bearer", "description": "Credential bound to the read_only_observer role and limited to operational projections." }, "AccountOAuth": { "type": "oauth2", "description": "Account tokens authorize only their approving account and case scope. S256 PKCE is mandatory on the code flow. Explicit reacceptance is required after Rules/disclosure changes.", "flows": { "authorizationCode": { "authorizationUrl": "https://peoplescourt.ai/oauth/authorize", "tokenUrl": "https://peoplescourt.ai/api/oauth/token", "refreshUrl": "https://peoplescourt.ai/api/oauth/token", "scopes": { "cases:read": "cases:read", "executions:report": "Record performance reports and opposite-side responses; no provider release", "filings:write": "filings:write", "answers:write": "answers:write", "submissions:write": "submissions:write", "records:confirm": "records:confirm", "records:write": "records:write", "invitations:write": "invitations:write", "messages:write": "messages:write", "remedies:write": "remedies:write", "consents:write": "consents:write", "offline_access": "offline_access", "representatives:manage": "representatives:manage", "procedural:request": "procedural:request", "termination:write": "termination:write" } }, "clientCredentials": { "tokenUrl": "https://peoplescourt.ai/api/oauth/token", "scopes": { "cases:read": "cases:read", "executions:report": "Record performance reports and opposite-side responses; no provider release", "filings:write": "filings:write", "answers:write": "answers:write", "submissions:write": "submissions:write", "records:confirm": "records:confirm", "records:write": "records:write", "invitations:write": "invitations:write", "messages:write": "messages:write", "remedies:write": "remedies:write", "consents:write": "consents:write", "representatives:manage": "representatives:manage", "procedural:request": "procedural:request", "termination:write": "termination:write" } } } } }, "parameters": { "CaseId": { "name": "caseId", "in": "path", "required": true, "schema": { "type": "string" } }, "DraftId": { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" } }, "IdempotencyKey": { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 200 } }, "WebhookDeliveryId": { "name": "deliveryId", "in": "path", "required": true, "schema": { "type": "string" } }, "Party": { "name": "x-pc-party", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "claimant", "respondent" ] } }, "PartyToken": { "name": "x-arb-party-token", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Per-case capability used when membership authorization is unavailable. Optional with active membership for the matching side." }, "ContentDigest": { "name": "content-digest", "in": "header", "required": true, "description": "SHA-256 of the exact request bytes, formatted as an RFC 9530-style binary content digest. It is the final line of the canonical signature input.", "schema": { "type": "string", "pattern": "^sha-256=:[A-Za-z0-9+/]{43}=:$" } }, "PcEventId": { "name": "x-pc-event-id", "in": "header", "required": true, "description": "Stable signed event identity used for deduplication.", "schema": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,160}$" } }, "PcEventTimestamp": { "name": "x-pc-event-timestamp", "in": "header", "required": true, "description": "Canonical UTC ISO 8601 instant (the value must equal new Date(value).toISOString()).", "schema": { "type": "string", "format": "date-time", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\\.[0-9]{3}Z$" } }, "PcKeyId": { "name": "x-pc-key-id", "in": "header", "required": true, "description": "Identifier of the Ed25519 verification key.", "schema": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,160}$" } }, "CaseEventSchemaVersion": { "name": "x-pc-schema-version", "in": "header", "required": true, "description": "Signed body schema version; must equal the body schemaVersion.", "schema": { "type": "string", "const": "case-event-v2" } }, "EvidenceSchemaVersion": { "name": "x-pc-schema-version", "in": "header", "required": true, "description": "Signed body schema version; must equal the body schemaVersion.", "schema": { "type": "string", "const": "evidence-export-notification-v1" } }, "PcSignatureVersion": { "name": "x-pc-signature-version", "in": "header", "required": true, "description": "Signature protocol version. It is validated as a constant; the canonical input is version-defined and does not include this header or the signature itself.", "schema": { "type": "string", "const": "pc-webhook-ed25519-v1" } }, "PcSignature": { "name": "x-pc-signature", "in": "header", "required": true, "description": "Ed25519 signature over the documented canonical input.", "schema": { "type": "string", "pattern": "^ed25519=:[A-Za-z0-9+/]{86}==:$" } } }, "schemas": { "PartnerIntegrationSandbox": { "type": "object", "required": [ "id", "environment", "generation", "createdAt", "cases" ], "properties": { "id": { "type": "string" }, "environment": { "const": "test" }, "generation": { "type": "integer", "minimum": 1 }, "createdAt": { "type": "string", "format": "date-time" }, "workflow": { "type": "object", "additionalProperties": false, "required": [ "command", "demoCommand", "isolation", "synthetic" ], "properties": { "command": { "const": "npm run sandbox:partner" }, "demoCommand": { "const": "npm run sandbox:partner -- --demo" }, "isolation": { "const": "temporary_local_process" }, "synthetic": { "const": true } } }, "cases": { "type": "array", "items": { "type": "object", "required": [ "id", "schemaVersion", "synthetic", "environment", "stage", "parties", "claim", "decision", "execution", "nextStep" ], "properties": { "id": { "type": "string" }, "schemaVersion": { "const": "sandbox-case-v1" }, "synthetic": { "const": true }, "environment": { "const": "test" }, "stage": { "enum": [ "prepared_filing", "awaiting_answer", "exchange", "served_award", "appeal_pending", "final" ] }, "parties": { "type": "object", "required": [ "claimant", "respondent" ], "properties": { "claimant": { "type": "string" }, "respondent": { "type": "string" } } }, "claim": { "type": "object", "required": [ "currency", "minorUnits" ], "properties": { "currency": { "const": "USD" }, "minorUnits": { "const": "10000" } } }, "decision": { "type": "object", "required": [ "served", "final", "appealPending" ], "properties": { "served": { "type": "boolean" }, "final": { "type": "boolean" }, "appealPending": { "type": "boolean" } } }, "execution": { "type": "object", "required": [ "mode", "paymentConfirmed" ], "properties": { "mode": { "const": "disabled" }, "paymentConfirmed": { "const": false } } }, "nextStep": { "type": "string" } } } } } }, "AwardExecutionCommand": { "discriminator": { "propertyName": "action" }, "oneOf": [ { "type": "object", "additionalProperties": false, "required": [ "action", "awardHash" ], "properties": { "action": { "type": "string", "enum": [ "initialize" ] }, "awardHash": { "type": "string" } } }, { "type": "object", "additionalProperties": false, "required": [ "action", "awardHash" ], "properties": { "action": { "type": "string", "enum": [ "request_release" ] }, "awardHash": { "type": "string" } } }, { "type": "object", "additionalProperties": false, "required": [ "action", "awardHash", "description" ], "properties": { "action": { "type": "string", "enum": [ "report_performance" ] }, "awardHash": { "type": "string" }, "description": { "type": "string", "minLength": 1, "maxLength": 4000 }, "reference": { "type": "string", "minLength": 1, "maxLength": 500 } } }, { "type": "object", "additionalProperties": false, "required": [ "action", "awardHash", "reportId" ], "properties": { "action": { "type": "string", "enum": [ "acknowledge" ] }, "awardHash": { "type": "string" }, "reportId": { "type": "string", "minLength": 1, "maxLength": 100 }, "reason": { "type": "string", "minLength": 1, "maxLength": 4000 } } }, { "type": "object", "additionalProperties": false, "required": [ "action", "awardHash", "reportId" ], "properties": { "action": { "type": "string", "enum": [ "dispute" ] }, "awardHash": { "type": "string" }, "reportId": { "type": "string", "minLength": 1, "maxLength": 100 }, "reason": { "type": "string", "minLength": 1, "maxLength": 4000 } } }, { "type": "object", "additionalProperties": false, "required": [ "action", "awardHash", "reason" ], "properties": { "action": { "type": "string", "enum": [ "will_not_execute" ] }, "awardHash": { "type": "string" }, "reason": { "type": "string", "minLength": 1, "maxLength": 4000 } } }, { "type": "object", "additionalProperties": false, "required": [ "action", "awardHash", "reference" ], "properties": { "action": { "type": "string", "enum": [ "partner_receipt" ] }, "awardHash": { "type": "string" }, "reference": { "type": "string", "minLength": 1, "maxLength": 500 } } } ] }, "ExecutionPerformanceResponse": { "type": "object", "additionalProperties": false, "required": [ "by", "status", "at" ], "properties": { "by": { "type": "string", "enum": [ "claimant", "respondent" ] }, "status": { "type": "string", "enum": [ "acknowledged", "disputed" ] }, "reason": { "type": "string" }, "at": { "type": "string", "format": "date-time" } } }, "ExecutionPerformanceReport": { "type": "object", "additionalProperties": false, "required": [ "id", "by", "description", "reportedAt", "responses" ], "properties": { "id": { "type": "string" }, "by": { "type": "string", "enum": [ "claimant", "respondent", "partner" ] }, "description": { "type": "string" }, "reference": { "type": "string" }, "reportedAt": { "type": "string", "format": "date-time" }, "responses": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutionPerformanceResponse" } } } }, "ExecutionNonPerformanceAttestation": { "type": "object", "additionalProperties": false, "required": [ "reason", "at" ], "properties": { "reason": { "type": "string" }, "at": { "type": "string", "format": "date-time" } } }, "ExecutionReceiptProvenance": { "type": "string", "enum": [ "live", "test", "synthetic" ], "description": "Provider environment recorded by the engine. Missing historical provenance never confirms payment." }, "ExecutionReceipt": { "type": "object", "additionalProperties": false, "required": [ "adapter", "action", "txHashes", "at" ], "properties": { "adapter": { "type": "string" }, "action": { "type": "string", "enum": [ "capture", "void", "capture_partial", "refund", "refuse", "complete", "reject", "distribute", "partner_execute" ] }, "txHashes": { "type": "array", "items": { "type": "string" } }, "at": { "type": "string", "format": "date-time" }, "detail": { "type": "string" }, "provenance": { "$ref": "#/components/schemas/ExecutionReceiptProvenance" } } }, "AwardExecutionResource": { "type": "object", "required": [ "id", "caseId", "awardId", "awardHash", "mode", "status", "paymentConfirmed", "executedBy", "receipt", "reports", "links" ], "properties": { "provider": { "type": "string" }, "providerOperation": { "type": "object", "required": [ "id", "status", "attempts" ], "properties": { "id": { "type": "string" }, "status": { "enum": [ "prepared", "submitting", "unknown", "confirmed", "needs_action" ] }, "attempts": { "type": "integer", "minimum": 0 } } }, "reconciliation": { "type": "object", "required": [ "state", "checkedAt", "recovery" ], "properties": { "state": { "enum": [ "pending", "unknown", "confirmed", "needs_action", "reversed" ] }, "checkedAt": { "type": [ "string", "null" ], "format": "date-time" }, "recovery": { "type": [ "object", "null" ], "properties": { "reason": { "enum": [ "vacated", "superseded", "provider_reversal" ] }, "status": { "enum": [ "pending", "reversed", "needs_action" ] }, "detail": { "type": "string" }, "requestedAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "providerReceipts": { "type": "array", "items": { "type": "object", "required": [ "step", "id", "object", "amount", "currency", "livemode", "status" ], "properties": { "step": { "enum": [ "debit", "transfer", "reverse_transfer", "refund_debit" ] }, "id": { "type": "string" }, "object": { "enum": [ "charge", "payment", "transfer", "transfer_reversal", "refund" ] }, "amount": { "type": "integer", "minimum": 1 }, "currency": { "const": "usd" }, "livemode": { "type": "boolean" }, "source": { "type": "string" }, "destination": { "type": "string" }, "status": { "type": "string" } } } }, "id": { "type": "string" }, "caseId": { "type": "string" }, "awardId": { "type": "string" }, "awardHash": { "type": "string" }, "mode": { "type": "string", "enum": [ "partner_executed", "court_escrow", "external_provider", "decision_only" ] }, "status": { "type": "string", "enum": [ "decision_delivered", "execution_pending", "overdue", "will_not_execute", "not_automatically_executed", "performance_reported", "performance_acknowledged", "performance_disputed", "not_requested", "pending", "unknown_outcome", "needs_action", "blocked", "executed", "simulated", "reversal_pending", "reversed", "reversal_needs_action" ] }, "paymentConfirmed": { "type": "boolean" }, "executedBy": { "type": [ "string", "null" ], "enum": [ "partner", "peoples_court", "provider", null ] }, "receipt": { "oneOf": [ { "$ref": "#/components/schemas/ExecutionReceipt" }, { "type": "null" } ] }, "reports": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutionPerformanceReport" } }, "attestation": { "oneOf": [ { "$ref": "#/components/schemas/ExecutionNonPerformanceAttestation" }, { "type": "null" } ] }, "submissionAttempts": { "type": [ "integer", "null" ], "minimum": 0, "description": "Durable adapter invocations, excluding reconciliation reads. Historical counts are null when unavailable. An invocation may stop before provider submission." }, "deliveredAt": { "type": "string", "format": "date-time" }, "overdueAt": { "type": [ "string", "null" ], "format": "date-time" }, "nextReconcileAt": { "type": [ "string", "null" ], "format": "date-time" }, "reminders": { "type": "integer", "minimum": 0 }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "links": { "type": "object", "required": [ "self", "case" ], "properties": { "self": { "type": "string" }, "case": { "type": "string" } } } } }, "StripeConnectBinding": { "type": "object", "required": [ "adapter", "connectedAccountId", "amountUsd", "currency", "balanceTransfer" ], "properties": { "adapter": { "const": "stripe_connect" }, "connectedAccountId": { "type": "string" }, "amountUsd": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "const": "usd" }, "buyerReference": { "type": "string" }, "balanceTransfer": { "type": "object", "required": [ "id", "partnerId", "environment", "payerConnectedAccountId", "payerSide", "payeeSide", "debitConsentReference" ], "properties": { "id": { "type": "string" }, "partnerId": { "type": "string" }, "environment": { "enum": [ "test", "live" ] }, "payerConnectedAccountId": { "type": "string" }, "payerSide": { "enum": [ "claimant", "respondent" ] }, "payeeSide": { "enum": [ "claimant", "respondent" ] }, "debitConsentReference": { "type": "string" } } } }, "x-mcp-exposure": "none" }, "StripeConnectedAccount": { "type": "object", "required": [ "id", "environment", "status", "admittedAt" ], "properties": { "id": { "type": "string" }, "accountId": { "type": "string" }, "accountApiVersion": { "type": "string", "enum": [ "v1", "v2" ], "description": "Stripe Accounts API used by this linked account. Historical records may omit this field and use v1." }, "environment": { "enum": [ "test", "live" ] }, "status": { "enum": [ "pending", "requirements_due", "ready", "restricted" ] }, "admittedAt": { "type": "string", "format": "date-time" }, "chargesEnabled": { "type": "boolean" }, "payoutsEnabled": { "type": "boolean" }, "requirementsDue": { "type": "array", "items": { "type": "string" } }, "checkedAt": { "type": "string", "format": "date-time" } }, "x-mcp-exposure": "none" }, "AccountFiling": { "type": "object", "description": "Canonical filing preparation input for a People's Court account token. The claimant is resolved from the authenticated account and is never supplied here; no partner tenant, credential, consent artifact or representative appointment participates. Agreement to arbitrate and the attestation of truthfulness are made by the person on the hosted acceptance page, so they are not request fields.", "required": [ "parties", "summary", "claim", "declaration" ], "additionalProperties": false, "properties": { "procedure": { "type": "string", "const": "standard", "description": "Only the standard procedure is available here. The agent-only procedure requires each side's express acceptance of the exact procedure through its own endpoint." }, "parties": { "type": "object", "required": [ "respondent" ], "additionalProperties": false, "properties": { "claimant": { "type": "object", "additionalProperties": false, "properties": { "principalKind": { "type": "string", "enum": [ "individual", "organization", "autonomous_agent" ], "description": "Optional assertion that must match the authenticated account's own principal kind." } } }, "respondent": { "type": "object", "required": [ "name", "principalKind" ], "additionalProperties": false, "properties": { "name": { "type": "string", "maxLength": 200 }, "principalKind": { "type": "string", "enum": [ "individual", "organization" ] }, "email": { "type": "string", "maxLength": 320 }, "emailIsProper": { "type": "boolean", "const": true, "description": "Required with an email address. The claimant attests this is the defendant's current address for the transaction or notices." }, "emailSource": { "type": "string", "enum": [ "claimant_attested", "agreement", "notice_designation" ] } } } } }, "summary": { "type": "string", "maxLength": 20000 }, "backgroundFacts": { "type": "string", "maxLength": 20000 }, "governingLaw": { "type": "string", "enum": [ "platform_native", "common_law_contract", "custom_terms", "english_law", "singapore_law", "new_york_law", "delaware_law" ] }, "customTerms": { "type": "string", "maxLength": 20000 }, "claimAmount": { "$ref": "#/components/schemas/FiatMoney" }, "remedialJurisdictionOptIn": { "type": "boolean" }, "claim": { "type": "object", "required": [ "statement", "requestedItems" ], "additionalProperties": false, "properties": { "statement": { "type": "string", "maxLength": 20000 }, "requestedItems": { "type": "array", "minItems": 1, "maxItems": 3, "description": "One typed item per kind. A monetary item requires a positive claimAmount; a declaration must begin \"Declare that\".", "items": { "type": "object", "required": [ "kind", "text" ], "additionalProperties": false, "properties": { "kind": { "type": "string", "enum": [ "monetary", "declaratory", "order" ] }, "text": { "type": "string", "maxLength": 4000 } } } } } }, "declaration": { "type": "object", "required": [ "declarantName", "declarantCapacity", "executionLocation" ], "additionalProperties": false, "properties": { "declarantName": { "type": "string", "maxLength": 200 }, "declarantCapacity": { "type": "string", "maxLength": 200 }, "executionLocation": { "type": "string", "maxLength": 200 } } } } }, "AccountFilingReviewPacket": { "type": "object", "description": "The exact packet the person reviews and accepts on People's Court. It contains only prepared typed filing fields; no capability, token or private preparation note enters it.", "properties": { "schemaVersion": { "type": "string", "const": "account-filing-review-packet-v1" }, "draftId": { "type": "string" }, "caseId": { "type": "string", "description": "Case identity reserved for this packet." }, "draftDigest": { "type": "string" }, "termsDigest": { "type": "string" }, "acceptanceStatement": { "type": "string" }, "parties": { "type": "object", "required": [ "claimant", "respondent" ], "properties": { "claimant": { "type": "object", "required": [ "principalId", "name", "principalKind" ], "properties": { "principalId": { "type": "string" }, "name": { "type": "string" }, "principalKind": { "$ref": "#/components/schemas/CanonicalPrincipalKind" } } }, "respondent": { "type": "object", "required": [ "name", "principalKind" ], "properties": { "name": { "type": "string" }, "principalKind": { "$ref": "#/components/schemas/CanonicalPrincipalKind" }, "noticeAddress": { "type": "object", "required": [ "email", "source" ], "properties": { "email": { "type": "string" }, "source": { "type": "string", "enum": [ "claimant_attested", "agreement", "notice_designation" ] } } } } } } }, "claimantIdentity": { "type": "object", "required": [ "accountId", "email" ], "properties": { "accountId": { "type": "string" }, "email": { "type": "string" } } }, "agentOfRecord": { "type": "string" }, "claimSummary": { "type": "string" }, "claimStatement": { "type": "string" }, "requestedItems": { "type": "array", "items": { "type": "object", "required": [ "id", "kind", "text" ], "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "monetary", "declaratory", "order" ] }, "text": { "type": "string" }, "amount": { "$ref": "#/components/schemas/FiatMoney" } } } }, "amount": { "$ref": "#/components/schemas/FiatMoney" }, "governingLaw": { "type": "string" }, "rules": { "type": "object", "required": [ "version", "hash" ], "properties": { "version": { "type": "string" }, "hash": { "type": "string" } } }, "procedure": { "type": "object", "required": [ "name", "finalityPath", "schedule" ], "properties": { "name": { "type": "string", "const": "standard" }, "finalityPath": { "type": "string", "const": "human_appeal" }, "schedule": { "type": "object", "required": [ "profile" ], "properties": { "profile": { "type": "string", "const": "standard" } } } } }, "aiDisclosure": { "type": "object", "required": [ "version", "hash" ], "properties": { "version": { "type": "string" }, "hash": { "type": "string" } } }, "fees": { "type": "object", "description": "Quoted filing fee in exact USD at the published schedule's precision, its collection mode, and the stated prerequisite for opening under this packet. A payable fee is completed on People's Court; this branch initiates no payment.", "properties": { "collection": { "type": "string", "enum": [ "off", "waived", "collect" ] }, "payable": { "type": "boolean" }, "quotedUsd": { "type": "string" }, "tier": { "type": "string" }, "prerequisite": { "type": "string", "enum": [ "none", "filing_fee_paid_on_peoples_court" ] } }, "required": [ "collection", "payable", "quotedUsd", "tier", "prerequisite" ] }, "respondentConsent": { "type": "object", "required": [ "mode", "statement" ], "properties": { "mode": { "type": "string", "const": "deferred_hosted_account" }, "statement": { "type": "string" } } }, "requiredConfirmations": { "type": "array", "items": { "type": "object", "required": [ "side", "principalId", "required", "statement" ], "properties": { "side": { "type": "string", "const": "claimant" }, "principalId": { "type": "string" }, "required": { "type": "boolean", "const": true }, "statement": { "type": "string" } } } }, "declaration": { "type": "object", "required": [ "declarantName", "declarantCapacity", "executionLocation" ], "properties": { "declarantName": { "type": "string" }, "declarantCapacity": { "type": "string" }, "executionLocation": { "type": "string" } } }, "scope": { "type": "string" }, "expiresAt": { "type": "string" } }, "required": [ "schemaVersion", "draftId", "caseId", "draftDigest", "termsDigest", "acceptanceStatement", "parties", "claimantIdentity", "claimSummary", "claimStatement", "requestedItems", "amount", "governingLaw", "rules", "procedure", "aiDisclosure", "fees", "respondentConsent", "requiredConfirmations", "declaration", "scope", "expiresAt" ] }, "AccountPreparedFiling": { "type": "object", "description": "An immutable account-owned filing draft and its review packet.", "properties": { "schemaVersion": { "type": "string", "const": "account-filing-v1" }, "filingId": { "type": "string" }, "procedure": { "type": "string", "const": "standard" }, "schedule": { "type": "object", "required": [ "profile" ], "properties": { "profile": { "type": "string", "const": "standard" } } }, "status": { "type": "string", "enum": [ "awaiting_acceptance", "accepted" ] }, "owner": { "type": "object", "required": [ "accountId" ], "properties": { "accountId": { "type": "string" } } }, "draftDigest": { "type": "string" }, "termsDigest": { "type": "string" }, "expiresAt": { "type": "string" }, "acceptance": { "type": "object", "required": [ "required", "method", "recorded" ], "properties": { "required": { "type": "boolean", "const": true }, "method": { "type": "string", "const": "hosted_clickwrap" }, "recorded": { "type": "boolean" }, "acceptedAt": { "type": "string" } } }, "reviewPacket": { "$ref": "#/components/schemas/AccountFilingReviewPacket" }, "hostedAcceptanceUrl": { "type": "string", "description": "One-use hosted acceptance link returned once at preparation. Replays and draft GET omit it. Replacement requires explicit rotateAcceptanceLink outside the connector." } }, "required": [ "schemaVersion", "filingId", "procedure", "schedule", "status", "owner", "draftDigest", "termsDigest", "expiresAt", "acceptance", "reviewPacket" ] }, "AccountOpenedCase": { "type": "object", "description": "The case this account-owned packet opened. Show-once party capabilities are never returned to an application.", "properties": { "schemaVersion": { "type": "string", "const": "account-filing-v1" }, "filingId": { "type": "string" }, "caseId": { "type": "string" }, "status": { "type": "string" }, "filingFeePending": { "type": "boolean" }, "track": { "type": "string" }, "noticeQueued": { "type": "boolean" }, "noticeAddressMasked": { "type": "string" }, "acceptance": { "type": "object", "required": [ "method", "termsDigest" ], "properties": { "method": { "type": "string", "const": "hosted_clickwrap" }, "termsDigest": { "type": "string" }, "attestationHash": { "type": "string" } } }, "links": { "type": "object", "required": [ "casePage" ], "properties": { "casePage": { "type": "string" } } }, "idempotencyReplayed": { "type": "boolean" } }, "required": [ "schemaVersion", "filingId", "caseId", "status", "filingFeePending", "track", "noticeQueued", "acceptance", "links", "idempotencyReplayed" ] }, "CanonicalRemedyInput": { "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 0 }, "notice": { "type": "string" }, "claimedErrors": { "type": "array", "items": { "type": "string" } }, "outcomeEffect": { "type": "string" }, "response": { "type": "string" }, "crossErrors": { "type": "array", "items": { "type": "string" } }, "requestedDisposition": { "type": "string" }, "kind": { "type": "string", "enum": [ "correction", "additional_award" ] }, "request": { "type": "string" }, "pleadedReliefIndex": { "type": "integer", "minimum": 0 }, "correctionTarget": { "description": "Required for correction after a Rules 1.0 modification, substitution, or vacatur. Vacatur permits only appellate_text. Unchanged funds instructions retain the original request deadline.", "oneOf": [ { "type": "object", "required": [ "kind" ], "additionalProperties": false, "properties": { "kind": { "type": "string", "const": "appellate_text" } } }, { "type": "object", "required": [ "kind", "index" ], "additionalProperties": false, "properties": { "kind": { "type": "string", "const": "funds_instruction" }, "index": { "type": "integer", "minimum": 0 } } } ] }, "action": { "type": "string", "enum": [ "file", "respond" ] }, "requestId": { "type": "string" } } }, "CanonicalMutationInput": { "type": "object", "deprecated": true, "description": "Superseded by the operation-specific canonical request schemas (CanonicalAnswerInput, CanonicalRecordCorrectionInput, CanonicalRecordConfirmationInput, CanonicalInvitationInput), which state each operation's required fields. Retained so existing clients that reference this name keep a resolvable schema; no operation uses it.", "properties": { "principalKind": { "type": "string", "enum": [ "individual", "organization", "autonomous_agent" ] }, "position": { "type": "string" }, "recordDigest": { "type": "string" }, "confirmationStatement": { "type": "string" }, "expectedRevision": { "type": "integer", "minimum": 0 }, "correction": { "type": "string" }, "action": { "type": "string", "enum": [ "rotate" ] } } }, "CanonicalEnvelope": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "description": "Caller-scoped case or operation projection. Procedure is standard or agent_only; principal kinds and representative roles use canonical vocabulary. Record summaries include preparationVersion, summary and exact confirmation digest. Invitations return hostedLink; show-once secrets are absent from replay." }, "requestId": { "type": "string" } } }, "CanonicalHostedMessageFields": { "type": "object", "description": "Hosted-thread message fields. A procedural request carries its typed procedural block, including any requested scheduling or filing effect.", "properties": { "body": { "type": "string", "maxLength": 2000 }, "threadId": { "type": "string" }, "category": { "type": "string", "enum": [ "technical_problem", "accessibility", "safety_security_privacy", "procedural_request", "scheduling_emergency" ] }, "visibility": { "type": "string", "enum": [ "shared", "confidential_admin" ] }, "procedural": { "type": "object", "properties": { "kind": { "type": "string" }, "requestedRelief": { "type": "string" }, "requestedEffect": { "type": "object", "properties": {} }, "urgency": { "type": "string" }, "urgencyBasis": { "type": "string" }, "urgencyNeededBy": { "type": "string" } } } } }, "CanonicalHostedThreadMessage": { "allOf": [ { "$ref": "#/components/schemas/CanonicalHostedMessageFields" } ], "required": [ "body", "category" ], "description": "Opens a hosted thread. A new thread must state a valid category; confidential administration is limited to the technical, accessibility, safety, security and privacy categories." }, "CanonicalHostedThreadReply": { "allOf": [ { "$ref": "#/components/schemas/CanonicalHostedMessageFields" } ], "required": [ "body", "threadId" ], "description": "Replies inside an existing hosted thread, which keeps the category and visibility it was opened with." }, "CanonicalCaseMessageInput": { "description": "Canonical case message. A session or account caller opens a hosted thread or replies within one; a partner bearer posts a procedural notice on the partner_notice channel.", "anyOf": [ { "$ref": "#/components/schemas/CanonicalHostedThreadMessage" }, { "$ref": "#/components/schemas/CanonicalHostedThreadReply" }, { "$ref": "#/components/schemas/PartnerProceduralMessageInput" } ] }, "CanonicalTerminationConfirmationInput": { "type": "object", "additionalProperties": false, "required": [ "expectedRevision" ], "properties": { "expectedRevision": { "type": "integer", "minimum": 0 }, "adoption": { "$ref": "#/components/schemas/RulesAdoptionAssent" }, "externalProtocolReference": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,200}$" } } }, "CanonicalSubmissionForm": { "type": "object", "required": [ "party", "brief" ], "properties": { "party": { "type": "string", "enum": [ "claimant", "respondent" ] }, "brief": { "type": "string" }, "files": { "type": "array", "items": { "type": "string", "contentEncoding": "binary" } }, "evidenceCandidateRefs": { "type": "string", "description": "JSON array of exportRecordId and artifactRef objects." }, "attest": { "type": "string", "const": "true", "description": "Required for hosted-session and account-OAuth human declarations. The person must explicitly affirm truthfulness; never infer or default it. Partner protocol filings use their separately authorized certification." }, "declarantName": { "type": "string" }, "declarantCapacity": { "type": "string" }, "executionLocation": { "type": "string" } } }, "CanonicalReplacementForm": { "type": "object", "required": [ "party", "brief" ], "properties": { "party": { "type": "string", "enum": [ "claimant", "respondent" ] }, "brief": { "type": "string" }, "files": { "type": "array", "items": { "type": "string", "contentEncoding": "binary" } }, "evidenceCandidateRefs": { "type": "string", "description": "JSON array of exportRecordId and artifactRef objects." }, "attest": { "type": "string", "const": "true", "description": "Required for hosted session declarations; not accepted by the bearer endpoint." }, "declarantName": { "type": "string" }, "declarantCapacity": { "type": "string" }, "executionLocation": { "type": "string" } } }, "CanonicalAmendmentForm": { "type": "object", "required": [ "brief", "reason" ], "properties": { "brief": { "type": "string" }, "reason": { "type": "string" } } }, "CanonicalAnswerFields": { "type": "object", "description": "Answer fields shared by every credential class. The three input schemas that compose this one state which of them each credential class must send.", "properties": { "agree": { "type": "boolean", "description": "Required for a session caller; the hosted operation refuses an Answer without it." }, "principalKind": { "type": "string", "description": "Canonical vocabulary for the responding principal. The adapter maps it to the stored party type; do not also send type.", "enum": [ "individual", "organization", "autonomous_agent" ] }, "type": { "type": "string", "enum": [ "human", "entity", "agent" ] }, "name": { "type": "string" }, "position": { "type": "string", "maxLength": 20000, "description": "Required for a bearer Answer." }, "evidence": { "type": "array", "items": { "type": "string" } }, "relief": { "type": "string", "maxLength": 2000 }, "declaratoryRelief": { "type": "string", "maxLength": 4000 }, "orderRelief": { "type": "string", "maxLength": 4000 }, "hasPrincipal": { "type": "boolean" }, "principalCompressedClockConsent": { "type": "boolean" }, "protocolActor": { "type": "string", "description": "Required with protocolPrincipal and protocolSource for a membership-authorized bearer Answer." }, "protocolPrincipal": { "type": "string" }, "protocolSource": { "type": "string" }, "inviteToken": { "type": "string", "description": "Wallet-invite Answer only; a membership-authorized Answer must omit it." }, "walletAddress": { "type": "string" }, "signature": { "type": "string" }, "attest": { "type": "boolean" }, "declarantName": { "type": "string" }, "declarantCapacity": { "type": "string" }, "executionLocation": { "type": "string" }, "openingDraftDigest": { "type": "string" }, "acceptanceStatementHash": { "type": "string" } } }, "CanonicalSessionAnswerInput": { "allOf": [ { "$ref": "#/components/schemas/CanonicalAnswerFields" } ], "required": [ "agree", "position", "attest", "declarantName", "declarantCapacity", "executionLocation" ], "description": "Account session Answer. The operation refuses an Answer without agreement to arbitrate and without the complete human declaration. A respondent who is not the case's verified contact also presents the invitation through inviteToken, and a case opened with pinned hosted terms presents the exact openingDraftDigest and acceptanceStatementHash from that invitation; both stay optional here because they depend on how the respondent was designated, not on the Answer itself. Membership proof, invitation use, consent and the Answer remain one atomic commit." }, "CanonicalPartnerAnswerInput": { "allOf": [ { "$ref": "#/components/schemas/CanonicalAnswerFields" } ], "required": [ "position", "protocolActor", "protocolPrincipal", "protocolSource" ], "description": "Membership-authorized bearer Answer. The protocol provenance names the acting agent, its principal and the source that authorizes it; invite and wallet proof fields must be absent." }, "CanonicalWalletAnswerInput": { "allOf": [ { "$ref": "#/components/schemas/CanonicalAnswerFields" } ], "required": [ "position", "inviteToken", "walletAddress", "signature" ], "description": "Wallet-invitation Answer. The signature is verified against the invitation; membership protocol fields must be absent." }, "CanonicalAnswerInput": { "description": "Canonical Answer body. Exactly one credential class applies per request, and each states its own required fields.", "anyOf": [ { "$ref": "#/components/schemas/CanonicalSessionAnswerInput" }, { "$ref": "#/components/schemas/CanonicalPartnerAnswerInput" }, { "$ref": "#/components/schemas/CanonicalWalletAnswerInput" } ] }, "CanonicalRecordConfirmationInput": { "type": "object", "required": [ "recordDigest", "confirmationStatement" ], "description": "Exact confirmation of the caller's current party record. Both values come unchanged from the case view's confirm_record requirements or from the record-summary read; the operation refuses any other value.", "properties": { "recordDigest": { "type": "string", "description": "Exact digest of the caller's current record." }, "confirmationStatement": { "type": "string", "description": "Exact confirmation sentence bound to that digest." }, "inventoryDigest": { "type": "string", "description": "Session callers on the confirmed-request-inventory preparation may also echo the exact displayed request-list digest." }, "party": { "type": "string", "description": "Optional for a session caller holding authority for both sides; a bearer's party comes from its membership.", "enum": [ "claimant", "respondent" ] }, "expectedRevision": { "type": "integer", "minimum": 0 } } }, "CanonicalRecordCorrectionInput": { "type": "object", "required": [ "correction" ], "description": "Rule 4.8 correction request against the caller's current party record.", "properties": { "correction": { "type": "string", "minLength": 1, "maxLength": 4000 }, "party": { "type": "string", "enum": [ "claimant", "respondent" ] }, "expectedRevision": { "type": "integer", "minimum": 0 } } }, "CanonicalInvitationInput": { "type": "object", "additionalProperties": false, "description": "Respondent invitation rotation. The operation accepts an empty object or the single rotate action; any other field is refused. No required field exists because rotation is the only supported act.", "properties": { "action": { "type": "string", "enum": [ "rotate" ] } } }, "CanonicalEvidenceRead": { "type": "object", "maxProperties": 0, "description": "Authorized evidence download. The advertised read_evidence action takes no request body; the response is the evidence file." }, "CanonicalCaseAction": { "type": "object", "required": [ "code", "method", "href", "inputSchema", "expectedRevision", "requirements" ], "description": "One authorized, discoverable action. href is the canonical URL and inputSchema names the published request schema for it. requirements carry the exact values the operation checks, such as a record digest and its confirmation sentence; free-text fields remain the caller's.", "properties": { "code": { "type": "string" }, "method": { "type": "string", "enum": [ "POST", "PATCH", "GET" ] }, "href": { "type": "string" }, "inputSchema": { "type": "string", "description": "Name of a schema published under components.schemas in this contract." }, "expectedRevision": { "type": "integer", "minimum": 0 }, "requirements": { "type": "object", "properties": { "party": { "type": "string", "enum": [ "claimant", "respondent" ] }, "partyHeader": { "type": "string", "enum": [ "claimant", "respondent" ] }, "recordDigest": { "type": "string" }, "confirmationStatement": { "type": "string" }, "inventoryDigest": { "type": "string" }, "agree": { "type": "boolean" }, "idempotencyKey": { "type": "boolean" }, "protocolPrincipal": { "type": "string" }, "protocolActor": { "type": "string" }, "evidenceAttestation": { "type": "string" }, "kind": { "type": "string" }, "rule47Kind": { "type": "string" }, "rule47OrderId": { "type": "string" }, "submissionId": { "type": "string" }, "evidenceId": { "type": "string" }, "sourceId": { "type": "string" }, "grantId": { "type": "string" }, "requestId": { "type": "string" }, "channel": { "type": "string" }, "category": { "type": "string" }, "fee": { "type": "object", "properties": { "currency": { "type": "string" }, "minorUnits": { "type": "string" } } } } } } }, "CanonicalCaseDeadline": { "type": "object", "required": [ "kind", "dueAt", "effect" ], "properties": { "kind": { "type": "string" }, "party": { "type": "string", "enum": [ "claimant", "respondent" ] }, "dueAt": { "type": "string", "format": "date-time" }, "effect": { "type": "string" } } }, "CanonicalCaseProcessingStatus": { "type": "object", "additionalProperties": false, "required": [ "blocker", "lastProgress", "nextActor" ], "description": "Closed procedural codes projected from stored state. Outside under_review all three fields are null. These fields report workflow progress, not a merits result or completion estimate. No run logs, provider diagnostics, private record state, model identities or unserved work are exposed.", "properties": { "blocker": { "type": [ "string", "null" ], "enum": [ "queued", "adjudication", "technical_failure", "procedure_hold", "ai_correction", "configuration_review", "operational_hold", "legacy_review", "award_service", "award_validation", "awaiting_start", null ] }, "lastProgress": { "type": [ "object", "null" ], "additionalProperties": false, "required": [ "code", "at" ], "description": "Latest stored run milestone; at is its completion, start or creation time, not a heartbeat.", "properties": { "code": { "type": "string", "enum": [ "queued", "started", "completed", "failed", "interrupted", "timed_out", "cancelled" ] }, "at": { "type": "string", "format": "date-time" } } }, "nextActor": { "type": [ "string", "null" ], "enum": [ "service", "administrator", "tribunal", "legacy_reviewer", null ] } } }, "CanonicalCaseView": { "type": "object", "required": [ "id", "revision", "environment", "externalReferences", "procedure", "stage", "deadlines", "availableActions", "waitingOn", "decision", "execution", "links" ], "description": "Caller-scoped authorized case resource. Every field is projected from stored state and the same policy used for writes.", "properties": { "id": { "type": "string" }, "revision": { "type": "integer", "minimum": 0 }, "environment": { "type": "string", "enum": [ "test", "live", "unspecified" ] }, "externalReferences": { "type": "array", "items": { "type": "object", "required": [ "source", "id" ], "properties": { "source": { "type": "string" }, "id": { "type": "string" } } } }, "procedure": { "type": "object", "required": [ "mode", "caseMode", "rulesVersion", "rulesHash", "verifiedPrincipalBasis", "schedule" ], "properties": { "mode": { "type": "string", "description": "Procedural path. agent_only requires the exact bilateral autonomous-agent acceptance; a transport never selects it.", "enum": [ "standard", "agent_only" ] }, "caseMode": { "type": "string", "enum": [ "proceeding", "evaluation" ] }, "rulesVersion": { "type": [ "string", "null" ] }, "rulesHash": { "type": [ "string", "null" ] }, "verifiedPrincipalBasis": { "type": "string" }, "schedule": { "type": "object", "required": [ "deadlinePolicy" ], "properties": { "deadlinePolicy": { "type": [ "string", "null" ] } } } } }, "stage": { "type": "object", "required": [ "code", "phase", "recordRevision" ], "properties": { "code": { "type": "string", "enum": [ "awaiting_respondent", "exchange", "record_confirmation", "under_review", "served", "appeal", "final", "ended", "service_pending", "fee_pending" ] }, "phase": { "type": [ "string", "null" ], "enum": [ "answer", "evidence", "rebuttal", "close", "merits" ] }, "recordRevision": { "type": "integer", "minimum": 0 } } }, "deadlines": { "type": "array", "items": { "$ref": "#/components/schemas/CanonicalCaseDeadline" } }, "availableActions": { "type": "array", "items": { "$ref": "#/components/schemas/CanonicalCaseAction" } }, "processing": { "$ref": "#/components/schemas/CanonicalCaseProcessingStatus" }, "waitingOn": { "description": "During under_review, reason uses the processing.blocker code.", "type": "array", "items": { "type": "object", "required": [ "kind", "reason" ], "properties": { "kind": { "type": "string" }, "reason": { "type": "string" }, "party": { "type": "string" }, "dueAt": { "type": "string", "format": "date-time" } } } }, "decision": { "type": "object", "required": [ "served", "servedAt", "awardId", "hash", "revision", "appellateDisposition", "postAppealRequestScope", "appealEligible", "appealDeadline", "finality", "executable", "holdReasons" ], "description": "Served, appealable, final and executable are separate facts. A served Award may remain stayed.", "properties": { "served": { "type": "boolean" }, "servedAt": { "type": [ "string", "null" ] }, "awardId": { "type": [ "string", "null" ] }, "hash": { "type": [ "string", "null" ] }, "revision": { "type": [ "integer", "null" ] }, "appellateDisposition": { "type": [ "object", "null" ], "required": [ "outcome", "servedAt", "operativeAward" ], "properties": { "outcome": { "type": "string" }, "servedAt": { "type": "string" }, "operativeAward": { "type": "string" } } }, "postAppealRequestScope": { "description": "Pinned scope of post-appeal requests, or null when none applies." }, "appealEligible": { "type": "boolean" }, "appealDeadline": { "type": [ "string", "null" ] }, "finality": { "type": "string", "enum": [ "not_served", "served", "appealable", "appeal_reserved", "appeal_pending", "final" ] }, "executable": { "type": "boolean" }, "holdReasons": { "type": "array", "items": { "type": "string" } } } }, "execution": { "type": "object", "required": [ "status", "links" ], "properties": { "status": { "type": "string", "enum": [ "not_configured", "not_requested", "pending", "confirmed", "needs_action", "blocked", "failed", "unknown_outcome" ] }, "links": { "type": "object", "description": "Present only where an execution operation or receipt exists and the caller's interface can resolve it. Following them needs the separate settlement-execution credential.", "properties": { "operations": { "type": "string" }, "receipts": { "type": "string" } } } } }, "links": { "type": "object", "description": "Authorized resources for this caller. No invitation secret is ever returned here.", "properties": { "casePage": { "type": "string" }, "artifacts": { "type": "string" }, "docket": { "type": "string" }, "recordBundle": { "type": "string" }, "eventCursor": { "type": "string" } } } } }, "CanonicalCaseViewEnvelope": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/CanonicalCaseView" }, "requestId": { "type": "string" } } }, "CanonicalRecordSummary": { "type": "object", "required": [ "caseId", "party", "preparationVersion", "revision" ], "description": "The caller's own record summary. The exact digest, confirmation sentence and summary are absent while the stored record does not match the current source binding; regenerate the record before confirming.", "properties": { "caseId": { "type": "string" }, "party": { "type": "string", "enum": [ "claimant", "respondent" ] }, "preparationVersion": { "type": "string" }, "revision": { "type": "integer", "minimum": 0 }, "phase": { "type": "string" }, "confirmationDueAt": { "type": "string", "format": "date-time" }, "recordDigest": { "type": "string" }, "confirmationStatement": { "type": "string" }, "summary": { "type": [ "object", "null" ], "description": "Party-scoped restatement, including the source-bound request inventory and its displayed text on the current preparation.", "properties": { "text": { "type": "string" }, "generatedAt": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "confirmed", "corrected", "lapsed" ] }, "respondedAt": { "type": "string" }, "correction": { "type": "string" }, "revision": { "type": "integer" }, "sourceSubmissionIds": { "type": "array", "items": { "type": "string" } }, "sourceContentHashes": { "type": "array", "items": { "type": "string" } }, "sourceFingerprint": { "type": "string" }, "confirmationDueAt": { "type": "string" }, "rejectedCorrections": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "reason": { "type": "string" }, "at": { "type": "string" } } } }, "requestInventory": { "type": "object", "properties": { "version": { "type": "string" }, "party": { "type": "string", "enum": [ "claimant", "respondent" ] }, "sourceFingerprint": { "type": "string" }, "restatementRevision": { "type": "integer" }, "parents": { "type": "array", "items": { "type": "object", "properties": { "parentId": { "type": "string" }, "claimId": { "type": "string" }, "title": { "type": "string" }, "statement": { "type": "string" }, "kind": { "type": "string" }, "currency": { "type": "string" } } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string" }, "parentId": { "type": "string" }, "parentClaimId": { "type": "string" }, "kind": { "type": "string" }, "fixedText": { "type": "string" }, "requestedAmount": { "type": "number" }, "currency": { "type": "string" }, "canonicalDeclaration": { "type": "string" }, "canonicalOrder": { "type": "string" }, "severableScopes": { "type": "array", "items": { "type": "object", "properties": { "scopeId": { "type": "string" }, "fixedText": { "type": "string" }, "source": { "type": "object", "properties": { "sourceId": { "type": "string" }, "sourceContentHash": { "type": "string" }, "firstLine": { "type": "integer" }, "lastLine": { "type": "integer" }, "exactText": { "type": "string" } } } } } }, "source": { "type": "object", "properties": { "sourceId": { "type": "string" }, "sourceContentHash": { "type": "string" }, "firstLine": { "type": "integer" }, "lastLine": { "type": "integer" }, "exactText": { "type": "string" } } }, "residual": { "type": "boolean" } } } }, "originalParentCoverage": { "type": "array", "items": { "type": "string" } }, "displayText": { "type": "string" }, "displayDigest": { "type": "string" }, "inventoryHash": { "type": "string" }, "status": { "type": "string" }, "respondedAt": { "type": "string" } } }, "priorRevisions": { "type": "array", "items": { "$ref": "#/components/schemas/CanonicalPartyRestatementRevision" } } } } } }, "CanonicalRecordSummaryEnvelope": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/CanonicalRecordSummary" }, "requestId": { "type": "string" } } }, "CanonicalRecordCorrectionResult": { "type": "object", "required": [ "applied", "preparationVersion", "note" ], "description": "Bounded correction outcome. applied false means the note was referred under Rule 4.7 and the record on file is unchanged.", "properties": { "applied": { "type": "boolean" }, "phase": { "type": "string" }, "preparationVersion": { "type": "string" }, "note": { "type": "string" }, "restatement": { "type": "object", "description": "The party-scoped record after the correction, including the regenerated request list and its exact digest.", "properties": { "text": { "type": "string" }, "generatedAt": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "confirmed", "corrected", "lapsed" ] }, "respondedAt": { "type": "string" }, "correction": { "type": "string" }, "revision": { "type": "integer" }, "sourceSubmissionIds": { "type": "array", "items": { "type": "string" } }, "sourceContentHashes": { "type": "array", "items": { "type": "string" } }, "sourceFingerprint": { "type": "string" }, "confirmationDueAt": { "type": "string" }, "rejectedCorrections": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "reason": { "type": "string" }, "at": { "type": "string" } } } }, "requestInventory": { "type": "object", "properties": { "version": { "type": "string" }, "party": { "type": "string", "enum": [ "claimant", "respondent" ] }, "sourceFingerprint": { "type": "string" }, "restatementRevision": { "type": "integer" }, "parents": { "type": "array", "items": { "type": "object", "properties": { "parentId": { "type": "string" }, "claimId": { "type": "string" }, "title": { "type": "string" }, "statement": { "type": "string" }, "kind": { "type": "string" }, "currency": { "type": "string" } } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string" }, "parentId": { "type": "string" }, "parentClaimId": { "type": "string" }, "kind": { "type": "string" }, "fixedText": { "type": "string" }, "requestedAmount": { "type": "number" }, "currency": { "type": "string" }, "canonicalDeclaration": { "type": "string" }, "canonicalOrder": { "type": "string" }, "severableScopes": { "type": "array", "items": { "type": "object", "properties": { "scopeId": { "type": "string" }, "fixedText": { "type": "string" }, "source": { "type": "object", "properties": { "sourceId": { "type": "string" }, "sourceContentHash": { "type": "string" }, "firstLine": { "type": "integer" }, "lastLine": { "type": "integer" }, "exactText": { "type": "string" } } } } } }, "source": { "type": "object", "properties": { "sourceId": { "type": "string" }, "sourceContentHash": { "type": "string" }, "firstLine": { "type": "integer" }, "lastLine": { "type": "integer" }, "exactText": { "type": "string" } } }, "residual": { "type": "boolean" } } } }, "originalParentCoverage": { "type": "array", "items": { "type": "string" } }, "displayText": { "type": "string" }, "displayDigest": { "type": "string" }, "inventoryHash": { "type": "string" }, "status": { "type": "string" }, "respondedAt": { "type": "string" } } }, "priorRevisions": { "type": "array", "items": { "$ref": "#/components/schemas/CanonicalPartyRestatementRevision" } } } } } }, "CanonicalRecordCorrectionEnvelope": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/CanonicalRecordCorrectionResult" }, "requestId": { "type": "string" } } }, "CanonicalRecordConfirmationResult": { "type": "object", "required": [ "preparationVersion" ], "description": "Committed confirmation. A bearer result also carries the projected record-confirmation fields; a session result carries the confirmed party-scoped record. Only preparationVersion is guaranteed for both credential classes on both preparations.", "properties": { "preparationVersion": { "type": "string" }, "phase": { "type": "string" }, "status": { "type": "string" }, "confirmedAt": { "type": "string", "format": "date-time" }, "caseId": { "type": "string" }, "party": { "type": "string" }, "recordDigest": { "type": "string" }, "confirmationStatement": { "type": "string" }, "revision": { "type": "integer", "minimum": 0 }, "submissionIds": { "type": "array", "items": { "type": "string" } }, "restatement": { "type": "object", "properties": { "text": { "type": "string" }, "generatedAt": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "confirmed", "corrected", "lapsed" ] }, "respondedAt": { "type": "string" }, "correction": { "type": "string" }, "revision": { "type": "integer" }, "sourceSubmissionIds": { "type": "array", "items": { "type": "string" } }, "sourceContentHashes": { "type": "array", "items": { "type": "string" } }, "sourceFingerprint": { "type": "string" }, "confirmationDueAt": { "type": "string" }, "rejectedCorrections": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "reason": { "type": "string" }, "at": { "type": "string" } } } }, "requestInventory": { "type": "object", "properties": { "version": { "type": "string" }, "party": { "type": "string", "enum": [ "claimant", "respondent" ] }, "sourceFingerprint": { "type": "string" }, "restatementRevision": { "type": "integer" }, "parents": { "type": "array", "items": { "type": "object", "properties": { "parentId": { "type": "string" }, "claimId": { "type": "string" }, "title": { "type": "string" }, "statement": { "type": "string" }, "kind": { "type": "string" }, "currency": { "type": "string" } } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string" }, "parentId": { "type": "string" }, "parentClaimId": { "type": "string" }, "kind": { "type": "string" }, "fixedText": { "type": "string" }, "requestedAmount": { "type": "number" }, "currency": { "type": "string" }, "canonicalDeclaration": { "type": "string" }, "canonicalOrder": { "type": "string" }, "severableScopes": { "type": "array", "items": { "type": "object", "properties": { "scopeId": { "type": "string" }, "fixedText": { "type": "string" }, "source": { "type": "object", "properties": { "sourceId": { "type": "string" }, "sourceContentHash": { "type": "string" }, "firstLine": { "type": "integer" }, "lastLine": { "type": "integer" }, "exactText": { "type": "string" } } } } } }, "source": { "type": "object", "properties": { "sourceId": { "type": "string" }, "sourceContentHash": { "type": "string" }, "firstLine": { "type": "integer" }, "lastLine": { "type": "integer" }, "exactText": { "type": "string" } } }, "residual": { "type": "boolean" } } } }, "originalParentCoverage": { "type": "array", "items": { "type": "string" } }, "displayText": { "type": "string" }, "displayDigest": { "type": "string" }, "inventoryHash": { "type": "string" }, "status": { "type": "string" }, "respondedAt": { "type": "string" } } }, "priorRevisions": { "type": "array", "items": { "$ref": "#/components/schemas/CanonicalPartyRestatementRevision" } } } } } }, "CanonicalRecordConfirmationEnvelope": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/CanonicalRecordConfirmationResult" }, "requestId": { "type": "string" } } }, "CanonicalInvitationResult": { "type": "object", "required": [ "caseId", "hostedLink", "capabilityDelivery" ], "description": "Invitation rotation result. A show-once capability is never returned again on replay; hostedLink then addresses the hosted join page.", "properties": { "caseId": { "type": "string" }, "hostedLink": { "type": "string" }, "capabilityDelivery": { "type": "string" } } }, "CanonicalInvitationEnvelope": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/CanonicalInvitationResult" }, "requestId": { "type": "string" } } }, "CaseMembershipOperationV2": { "type": "string", "enum": [ "case:read", "submission:create", "restatement:respond", "record:confirm", "case:terminate", "award:read", "message:create", "evidence:challenge" ], "description": "Explicit per-case membership authority. Reads use case:read, procedural-message POST uses message:create, and authenticity-challenge POST uses evidence:challenge. A party token does not override a restricted active membership. Missing grants refuse with case_operation_forbidden. Existing memberships are not automatically expanded; the provisioning owner must grant new write operations explicitly." }, "Ap2SdJwtArtifactV1": { "type": "object", "additionalProperties": false, "required": [ "artifactId", "compactSdJwt", "disclosures", "keyBindingJwt" ], "properties": { "artifactId": { "type": "string" }, "compactSdJwt": { "type": "string" }, "disclosures": { "type": "array", "items": { "type": "string" } }, "keyBindingJwt": { "type": [ "string", "null" ] } } }, "Ap2TrustKeyV1": { "type": "object", "additionalProperties": false, "required": [ "issuer", "ap2Role", "kid", "alg", "purpose", "publicJwk", "thumbprintSha256", "notBefore", "expiresAt" ], "properties": { "issuer": { "type": "string" }, "ap2Role": { "type": "string", "enum": [ "trusted_surface", "credential_provider", "shopping_agent", "merchant", "merchant_payment_processor", "principal" ] }, "kid": { "type": "string" }, "alg": { "type": "string", "enum": [ "EdDSA", "ES256" ] }, "purpose": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "checkout_mandate", "payment_mandate", "key_binding", "checkout_jwt", "checkout_receipt", "payment_receipt", "resolution_authorization" ] } }, "publicJwk": { "type": "object", "description": "Public asymmetric JWK only; private d and symmetric k members are rejected." }, "thumbprintSha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "notBefore": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" } }, "allOf": [ { "if": { "properties": { "purpose": { "contains": { "type": "string", "const": "resolution_authorization" } } }, "required": [ "purpose" ] }, "then": { "properties": { "ap2Role": { "type": "string", "const": "principal" }, "purpose": { "type": "array", "minItems": 1, "maxItems": 1, "items": { "type": "string", "const": "resolution_authorization" } } } } } ] }, "Ap2EvidencePackageV1": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "ap2SpecVersion", "evidenceId", "transactionId", "acquiredAt", "source", "artifacts", "trust" ], "properties": { "schemaVersion": { "type": "string", "const": "ap2-evidence-package-v1" }, "ap2SpecVersion": { "type": "string", "const": "0.2" }, "evidenceId": { "type": "string" }, "transactionId": { "type": "string", "pattern": "^[A-Za-z0-9_-]{43}$" }, "acquiredAt": { "type": "string", "format": "date-time" }, "source": { "type": "object", "additionalProperties": false, "required": [ "partnerId", "exporterId", "sourceRoles" ], "properties": { "partnerId": { "type": "string" }, "exporterId": { "type": "string" }, "sourceRoles": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "trusted_surface", "credential_provider", "shopping_agent", "merchant", "merchant_payment_processor" ] } } } }, "artifacts": { "type": "object", "additionalProperties": false, "required": [ "checkoutMandates", "checkoutJwt", "checkoutReceipt", "paymentMandates", "paymentReceipt" ], "properties": { "checkoutMandates": { "type": "object", "additionalProperties": false, "required": [ "open", "closed" ], "properties": { "open": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/Ap2SdJwtArtifactV1" } }, "closed": { "$ref": "#/components/schemas/Ap2SdJwtArtifactV1" } } }, "checkoutJwt": { "type": "object", "additionalProperties": false, "required": [ "artifactId", "compactJwt" ], "properties": { "artifactId": { "type": "string" }, "compactJwt": { "type": "string" } } }, "checkoutReceipt": { "type": "object", "additionalProperties": false, "required": [ "artifactId", "compactJws" ], "properties": { "artifactId": { "type": "string" }, "compactJws": { "type": "string" } } }, "paymentMandates": { "type": "object", "additionalProperties": false, "required": [ "open", "closed" ], "properties": { "open": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/Ap2SdJwtArtifactV1" } }, "closed": { "$ref": "#/components/schemas/Ap2SdJwtArtifactV1" } } }, "paymentReceipt": { "type": "object", "additionalProperties": false, "required": [ "artifactId", "compactJws" ], "properties": { "artifactId": { "type": "string" }, "compactJws": { "type": "string" } } } } }, "trust": { "type": "object", "additionalProperties": false, "required": [ "policyId", "policyVersion", "exporterAttestationJws", "keys" ], "properties": { "policyId": { "type": "string" }, "policyVersion": { "type": "string" }, "exporterAttestationJws": { "type": "string" }, "keys": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/Ap2TrustKeyV1" } } } } } }, "Ap2TransactionEvidenceV1": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "ap2SpecVersion", "evidenceId", "transactionId", "acquiredAt", "source", "originalArtifacts", "sdJwtDisclosures", "checkoutJwt", "signingTrust", "normalizedTransaction", "verificationReport", "artifactHashes", "manifestHash" ], "properties": { "schemaVersion": { "type": "string", "const": "ap2-transaction-evidence-v1" }, "ap2SpecVersion": { "type": "string" }, "evidenceId": { "type": "string" }, "transactionId": { "type": "string", "pattern": "^[A-Za-z0-9_-]{43}$" }, "acquiredAt": { "type": "string", "format": "date-time" }, "source": { "type": "object", "additionalProperties": false, "required": [ "partnerId", "exporterId", "sourceRoles" ], "properties": { "partnerId": { "type": "string" }, "exporterId": { "type": "string" }, "sourceRoles": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "trusted_surface", "credential_provider", "shopping_agent", "merchant", "merchant_payment_processor" ] } } } }, "originalArtifacts": { "type": "object", "additionalProperties": false, "required": [ "checkoutMandates", "checkoutJwt", "checkoutReceipt", "paymentMandates", "paymentReceipt" ], "properties": { "checkoutMandates": { "type": "object", "additionalProperties": false, "required": [ "open", "closed" ], "properties": { "open": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/Ap2SdJwtArtifactV1" } }, "closed": { "$ref": "#/components/schemas/Ap2SdJwtArtifactV1" } } }, "checkoutJwt": { "type": "object", "additionalProperties": false, "required": [ "artifactId", "compactJwt" ], "properties": { "artifactId": { "type": "string" }, "compactJwt": { "type": "string" } } }, "checkoutReceipt": { "type": "object", "additionalProperties": false, "required": [ "artifactId", "compactJws" ], "properties": { "artifactId": { "type": "string" }, "compactJws": { "type": "string" } } }, "paymentMandates": { "type": "object", "additionalProperties": false, "required": [ "open", "closed" ], "properties": { "open": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/Ap2SdJwtArtifactV1" } }, "closed": { "$ref": "#/components/schemas/Ap2SdJwtArtifactV1" } } }, "paymentReceipt": { "type": "object", "additionalProperties": false, "required": [ "artifactId", "compactJws" ], "properties": { "artifactId": { "type": "string" }, "compactJws": { "type": "string" } } } } }, "sdJwtDisclosures": { "type": "object", "additionalProperties": false, "required": [ "checkout", "payment" ], "properties": { "checkout": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "payment": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } }, "checkoutJwt": { "type": "string" }, "signingTrust": { "type": "object", "additionalProperties": false, "required": [ "policyId", "policyVersion", "exporterAttestationJws", "keys" ], "properties": { "policyId": { "type": "string" }, "policyVersion": { "type": "string" }, "exporterAttestationJws": { "type": "string" }, "keys": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/Ap2TrustKeyV1" } } } }, "normalizedTransaction": { "type": "object", "additionalProperties": false, "required": [ "checkoutHash", "checkoutReceiptReference", "paymentReceiptReference", "merchantId", "orderId", "paymentId", "lineItemIds", "currency", "amountMinorUnits", "payee", "paymentAmount", "paymentInstrument" ], "properties": { "checkoutHash": { "type": "string" }, "checkoutReceiptReference": { "type": "string" }, "paymentReceiptReference": { "type": "string" }, "merchantId": { "type": "string" }, "orderId": { "type": "string" }, "paymentId": { "type": "string" }, "lineItemIds": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string" } }, "currency": { "type": "string" }, "amountMinorUnits": { "type": "string" }, "payee": { "type": "string" }, "paymentAmount": { "type": "string" }, "paymentInstrument": { "type": "string" } } }, "verificationReport": { "type": "object", "additionalProperties": false, "required": [ "verifier", "status", "verifiedAt", "trustPolicyId", "trustPolicyVersion", "checks", "missingArtifacts" ], "properties": { "verifier": { "type": "string", "const": "peoples-court-ap2-bridge-v1" }, "status": { "type": "string", "const": "passed" }, "verifiedAt": { "type": "string", "format": "date-time" }, "trustPolicyId": { "type": "string" }, "trustPolicyVersion": { "type": "string" }, "checks": { "type": "array", "minItems": 1, "items": { "type": "object", "additionalProperties": false, "required": [ "code", "status", "artifactIds", "detailCode" ], "properties": { "code": { "type": "string" }, "status": { "type": "string", "const": "passed" }, "artifactIds": { "type": "array", "items": { "type": "string" } }, "detailCode": { "type": "null" } } } }, "missingArtifacts": { "type": "array", "maxItems": 0, "items": { "type": "string" } } } }, "artifactHashes": { "type": "array", "minItems": 7, "items": { "type": "object", "additionalProperties": false, "required": [ "artifactId", "mediaType", "byteLength", "sha256" ], "properties": { "artifactId": { "type": "string" }, "mediaType": { "type": "string" }, "byteLength": { "type": "integer", "minimum": 1 }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } } }, "manifestHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "ResolutionAuthorizationV1": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "authorizationId", "transactionId", "effectiveAt", "expiresAt", "principals", "coveredTransaction", "coveredClaims", "appointment", "rules", "terms", "availableRemedies", "executionProvider", "proof" ], "properties": { "schemaVersion": { "type": "string", "const": "resolution-authorization-v1" }, "authorizationId": { "type": "string" }, "transactionId": { "type": "string", "pattern": "^[A-Za-z0-9_-]{43}$" }, "effectiveAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "principals": { "type": "array", "minItems": 2, "maxItems": 2, "allOf": [ { "contains": { "type": "object", "properties": { "side": { "type": "string", "const": "claimant" } }, "required": [ "side" ] }, "minContains": 1, "maxContains": 1 }, { "contains": { "type": "object", "properties": { "side": { "type": "string", "const": "respondent" } }, "required": [ "side" ] }, "minContains": 1, "maxContains": 1 } ], "items": { "type": "object", "additionalProperties": false, "required": [ "side", "principalId", "displayName", "capacity", "notice", "agentAuthority" ], "properties": { "side": { "type": "string", "enum": [ "claimant", "respondent" ] }, "principalId": { "type": "string" }, "displayName": { "type": "string" }, "capacity": { "type": "string", "enum": [ "individual", "legal_entity", "autonomous_agent" ] }, "notice": { "type": "object", "additionalProperties": false, "required": [ "method", "address" ], "properties": { "method": { "type": "string", "enum": [ "email", "partner_callback", "case_page" ] }, "address": { "type": "string" } } }, "agentAuthority": { "type": "object", "additionalProperties": false, "required": [ "agentId", "representedPrincipalId", "allowedActs", "maximumAmount", "expiresAt", "delegationArtifactRef", "delegationArtifactHash" ], "properties": { "agentId": { "type": "string" }, "representedPrincipalId": { "type": "string" }, "allowedActs": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "file_dispute", "submit_evidence", "settle_dispute", "confirm_record", "manage_representatives", "report_processing_defect", "file_procedural_request" ] } }, "maximumAmount": { "$ref": "#/components/schemas/ResolutionMoneyV1" }, "expiresAt": { "type": "string", "format": "date-time" }, "delegationArtifactRef": { "type": "string" }, "delegationArtifactHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } } } } }, "coveredTransaction": { "type": "object", "additionalProperties": false, "required": [ "transactionId", "merchantOrCounterpartyId", "evidenceManifestHash" ], "properties": { "transactionId": { "type": "string", "pattern": "^[A-Za-z0-9_-]{43}$" }, "merchantOrCounterpartyId": { "type": "string" }, "evidenceManifestHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "coveredClaims": { "$ref": "#/components/schemas/ResolutionCoveredClaimsV1" }, "appointment": { "$ref": "#/components/schemas/ResolutionAppointmentV1" }, "rules": { "$ref": "#/components/schemas/ResolutionRulesV1" }, "terms": { "$ref": "#/components/schemas/ResolutionTermsV1" }, "legalContext": { "$ref": "#/components/schemas/ResolutionLegalContextBindingV1" }, "availableRemedies": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/ResolutionRemedyV1" } }, "executionProvider": { "$ref": "#/components/schemas/ResolutionExecutionProviderV1" }, "proof": { "type": "object", "additionalProperties": false, "required": [ "format", "payload", "signatures" ], "properties": { "format": { "type": "string", "const": "jws-json-general" }, "payload": { "type": "string" }, "signatures": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "object", "additionalProperties": false, "required": [ "protected", "signature" ], "properties": { "protected": { "type": "string" }, "signature": { "type": "string" } } } } } } } }, "ResolutionMoneyV1": { "type": "object", "additionalProperties": false, "required": [ "currency", "minorUnits" ], "properties": { "currency": { "type": "string", "const": "USD" }, "minorUnits": { "type": "string", "pattern": "^[1-9][0-9]{0,14}$", "description": "Positive USD minor units, capped at exactly 15 decimal digits by Bridge v1." } } }, "ResolutionCoveredClaimsV1": { "type": "object", "additionalProperties": false, "required": [ "scope", "claimTypes", "maximumAmount" ], "properties": { "scope": { "type": "string" }, "claimTypes": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string" } }, "maximumAmount": { "$ref": "#/components/schemas/ResolutionMoneyV1" } } }, "ResolutionAppointmentV1": { "type": "object", "additionalProperties": false, "required": [ "administrator", "tribunal", "caseMode", "procedureProfile" ], "properties": { "administrator": { "type": "string", "const": "People's Court" }, "tribunal": { "type": "string", "const": "People's Court Tribunal" }, "caseMode": { "type": "string", "const": "evaluation" }, "procedureProfile": { "type": "string", "const": "evaluation" } } }, "ResolutionRulesV1": { "type": "object", "additionalProperties": false, "required": [ "rulesetId", "version", "hash", "url" ], "properties": { "rulesetId": { "type": "string" }, "version": { "type": "string" }, "hash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "url": { "type": "string", "format": "uri", "pattern": "^https://" } } }, "ResolutionTermsV1": { "type": "object", "additionalProperties": false, "required": [ "version", "hash" ], "properties": { "version": { "type": "string" }, "hash": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "ResolutionLegalContextBindingV1": { "type": "object", "additionalProperties": false, "required": [ "lcpSpecVersion", "legalContextSha256", "termsAtrHash", "clauseId", "clauseSha256", "rulesSha256", "catalogSha256", "providerId", "serviceId" ], "properties": { "lcpSpecVersion": { "type": "string", "const": "0.1.38" }, "legalContextSha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "termsAtrHash": { "type": "string", "pattern": "^0x[a-f0-9]{64}$" }, "clauseId": { "type": "string", "pattern": "^sha256:0x[a-f0-9]{64}$" }, "clauseSha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "rulesSha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "catalogSha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "providerId": { "type": "string", "minLength": 1, "maxLength": 16384 }, "serviceId": { "type": "string", "minLength": 1, "maxLength": 16384 } } }, "ResolutionRemedyV1": { "type": "object", "additionalProperties": false, "required": [ "code", "settlementAction", "maximumAmount" ], "properties": { "code": { "type": "string" }, "settlementAction": { "type": "string", "enum": [ "release_to_claimant", "release_to_respondent", "allocate_by_award", "none" ] }, "maximumAmount": { "$ref": "#/components/schemas/ResolutionMoneyV1" } } }, "ResolutionExecutionProviderV1": { "type": "object", "additionalProperties": false, "required": [ "providerId", "adapter", "mode", "externalReference", "allowedActions", "authorizationExpiresAt" ], "properties": { "providerId": { "type": "string" }, "adapter": { "type": "string" }, "mode": { "type": "string", "enum": [ "manual_partner", "partner_callback", "platform_adapter" ] }, "externalReference": { "type": "string" }, "allowedActions": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "release_to_claimant", "release_to_respondent", "allocate_by_award", "none" ] } }, "authorizationExpiresAt": { "type": "string", "format": "date-time" } } }, "ResolutionProposedCaseV1": { "description": "Unsigned transport intent compared exactly to both principals' signed authorization; it is never treated as consent.", "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "transactionId", "claimantPrincipalId", "respondentPrincipalId", "merchantOrCounterpartyId", "evidenceManifestHash", "coveredClaims", "appointment", "rules", "terms", "availableRemedies", "requestedRemedy", "executionProvider" ], "properties": { "schemaVersion": { "type": "string", "const": "resolution-proposed-case-v1" }, "transactionId": { "type": "string", "pattern": "^[A-Za-z0-9_-]{43}$" }, "claimantPrincipalId": { "type": "string" }, "respondentPrincipalId": { "type": "string" }, "merchantOrCounterpartyId": { "type": "string" }, "evidenceManifestHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "coveredClaims": { "$ref": "#/components/schemas/ResolutionCoveredClaimsV1" }, "appointment": { "$ref": "#/components/schemas/ResolutionAppointmentV1" }, "rules": { "$ref": "#/components/schemas/ResolutionRulesV1" }, "terms": { "$ref": "#/components/schemas/ResolutionTermsV1" }, "legalContext": { "$ref": "#/components/schemas/ResolutionLegalContextBindingV1" }, "availableRemedies": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/ResolutionRemedyV1" } }, "requestedRemedy": { "type": "object", "additionalProperties": false, "required": [ "action", "currency", "minorUnits" ], "properties": { "action": { "type": "string", "enum": [ "release_to_claimant", "release_to_respondent", "allocate_by_award", "none" ] }, "currency": { "type": "string", "const": "USD" }, "minorUnits": { "type": "string", "pattern": "^[1-9][0-9]{0,14}$" } } }, "executionProvider": { "$ref": "#/components/schemas/ResolutionExecutionProviderV1" } } }, "ResolutionFrozenRecordManifestV1": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "transactionId", "orderId", "disputedLineItemIds", "policyDigest", "termsDigest", "authorityRefs", "includedArtifacts", "excludedArtifacts" ], "properties": { "schemaVersion": { "type": "string", "const": "resolution-frozen-record-manifest-v1" }, "transactionId": { "type": "string" }, "orderId": { "type": "string" }, "disputedLineItemIds": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string" } }, "policyDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "termsDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "authorityRefs": { "type": "array", "minItems": 2, "uniqueItems": true, "items": { "type": "string" } }, "includedArtifacts": { "type": "array", "minItems": 1, "items": { "type": "object", "additionalProperties": false, "required": [ "artifactId", "sha256", "mediaType", "source" ], "properties": { "artifactId": { "type": "string" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "mediaType": { "type": "string" }, "source": { "type": "string" } } } }, "excludedArtifacts": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "artifactId", "reason" ], "properties": { "artifactId": { "type": "string" }, "reason": { "type": "string", "enum": [ "verifier_local_metadata", "outside_claim_scope", "duplicate" ] } } } } } }, "ResolutionHandoffV1": { "description": "Protocol-neutral frozen resolution input. Native verification provenance is excluded from stable artifact identity.", "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "handoffId", "disputeId", "nativeProtocol", "transaction", "roles", "claim", "merchantResponse", "requestedRemedy", "authority", "policy", "terms", "frozenRecord", "remedyCeilings", "resolver", "createdAt", "expiresAt", "nativeProof" ], "properties": { "schemaVersion": { "type": "string", "const": "resolution-handoff-v1" }, "handoffId": { "type": "string" }, "disputeId": { "type": "string" }, "nativeProtocol": { "type": "string", "enum": [ "ucp", "ap2", "x402", "a2a", "agentic_checkout_acp", "virtuals_acp", "custom" ] }, "transaction": { "type": "object", "additionalProperties": false, "required": [ "transactionId", "orderId", "disputedLineItemIds" ], "properties": { "transactionId": { "type": "string" }, "orderId": { "type": "string" }, "checkoutId": { "type": "string" }, "disputedLineItemIds": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string" } } } }, "roles": { "type": "object", "additionalProperties": false, "required": [ "claimant", "respondent", "recordIssuer", "resolver", "executor" ], "properties": { "claimant": { "type": "string" }, "respondent": { "type": "string" }, "recordIssuer": { "type": "string" }, "resolver": { "type": "string" }, "executor": { "type": "string" } } }, "claim": { "type": "object", "additionalProperties": false, "required": [ "claimId", "claimType", "artifactRef", "artifactHash" ], "properties": { "claimId": { "type": "string" }, "claimType": { "type": "string" }, "artifactRef": { "type": "string" }, "artifactHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "merchantResponse": { "type": "object", "additionalProperties": false, "required": [ "response", "artifactRef", "artifactHash" ], "properties": { "response": { "type": "string", "enum": [ "accepted", "partially_accepted", "denied", "no_response" ] }, "artifactRef": { "type": "string" }, "artifactHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "requestedRemedy": { "$ref": "#/components/schemas/ResolutionHandoffRemedyV1" }, "authority": { "type": "object", "additionalProperties": false, "required": [ "bilateral", "claimantAuthorityRef", "respondentAuthorityRef", "authorizationArtifactHash" ], "properties": { "bilateral": { "type": "boolean", "const": true }, "claimantAuthorityRef": { "type": "string" }, "respondentAuthorityRef": { "type": "string" }, "authorizationArtifactHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "policy": { "$ref": "#/components/schemas/ResolutionDigestVersionV1" }, "terms": { "$ref": "#/components/schemas/ResolutionDigestVersionV1" }, "frozenRecord": { "type": "object", "additionalProperties": false, "required": [ "canonicalization", "digestAlgorithm", "manifest", "digest" ], "properties": { "canonicalization": { "type": "string", "const": "RFC8785" }, "digestAlgorithm": { "type": "string", "const": "SHA-256" }, "manifest": { "$ref": "#/components/schemas/ResolutionFrozenRecordManifestV1" }, "digest": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "remedyCeilings": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/ResolutionHandoffRemedyV1" } }, "resolver": { "type": "object", "additionalProperties": false, "required": [ "resolverId", "rulesetId", "rulesVersion" ], "properties": { "resolverId": { "type": "string" }, "rulesetId": { "type": "string" }, "rulesVersion": { "type": "string" } } }, "createdAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "nativeProof": { "type": "object", "additionalProperties": false, "required": [ "artifactRef", "sha256", "verificationMethod" ], "properties": { "artifactRef": { "type": "string" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "verificationMethod": { "type": "string" } } }, "nativeVerification": { "type": "object", "additionalProperties": false, "required": [ "verifierId", "verifiedAt" ], "properties": { "verifierId": { "type": "string" }, "verifiedAt": { "type": "string", "format": "date-time" }, "fetchMetadata": { "type": "object", "additionalProperties": true } } } } }, "ResolutionHandoffRemedyV1": { "type": "object", "additionalProperties": false, "required": [ "action", "currency", "amountMinorUnits" ], "properties": { "action": { "type": "string", "enum": [ "refund", "release_to_claimant", "release_to_respondent", "allocate_by_award", "replace_product", "none" ] }, "currency": { "type": "string" }, "amountMinorUnits": { "type": "string", "pattern": "^(0|[1-9][0-9]*)$" } } }, "ResolutionDigestVersionV1": { "type": "object", "additionalProperties": false, "required": [ "version", "digest" ], "properties": { "version": { "type": "string" }, "digest": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "UcpOrderEvidenceV1": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "selectedUcpVersion", "profileId", "businessId", "orderId", "orderBytesBase64", "httpMessage" ], "properties": { "schemaVersion": { "type": "string", "const": "ucp-order-evidence-v1" }, "selectedUcpVersion": { "type": "string", "const": "2026-04-08" }, "profileId": { "type": "string" }, "businessId": { "type": "string" }, "orderId": { "type": "string" }, "orderBytesBase64": { "type": "string", "description": "Exact received UCP Order bytes encoded as canonical base64; re-serialization is not permitted." }, "httpMessage": { "type": "object", "additionalProperties": false, "required": [ "method", "targetUri", "contentDigest", "signatureInput", "signature" ], "properties": { "method": { "type": "string" }, "targetUri": { "type": "string", "format": "uri" }, "contentDigest": { "type": "string" }, "signatureInput": { "type": "string" }, "signature": { "type": "string" } } } } }, "UcpResolutionRequestV1": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "externalCaseId", "policyVersion", "exporterId", "orderEvidence", "resolutionHandoff", "resolutionAuthorization", "proposedCase" ], "properties": { "schemaVersion": { "type": "string", "const": "ucp-resolution-request-v1" }, "externalCaseId": { "type": "string" }, "policyVersion": { "type": "string" }, "exporterId": { "type": "string" }, "orderEvidence": { "$ref": "#/components/schemas/UcpOrderEvidenceV1" }, "resolutionHandoff": { "$ref": "#/components/schemas/ResolutionHandoffV1" }, "resolutionAuthorization": { "$ref": "#/components/schemas/ResolutionAuthorizationV1" }, "proposedCase": { "$ref": "#/components/schemas/ResolutionProposedCaseV1" } } }, "Ap2ResolutionRequestV1": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "externalCaseId", "policyVersion", "evidencePackage", "resolutionAuthorization", "proposedCase" ], "properties": { "schemaVersion": { "type": "string", "const": "ap2-resolution-request-v1" }, "externalCaseId": { "type": "string" }, "policyVersion": { "type": "string" }, "evidencePackage": { "$ref": "#/components/schemas/Ap2EvidencePackageV1" }, "resolutionAuthorization": { "$ref": "#/components/schemas/ResolutionAuthorizationV1" }, "proposedCase": { "$ref": "#/components/schemas/ResolutionProposedCaseV1" } } }, "Ap2ResolutionCaseV1": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "caseId", "externalCaseId", "status", "rules", "createdAt", "headless", "transactionId", "evidence", "resolutionAuthorization", "resolutionLifecycle", "settlementBinding", "resultPath" ], "properties": { "schemaVersion": { "type": "string", "const": "ap2-resolution-case-v1" }, "caseId": { "type": "string" }, "externalCaseId": { "type": "string" }, "status": { "type": "string" }, "rules": { "type": "object", "additionalProperties": false, "required": [ "version", "hash" ], "properties": { "version": { "type": "string" }, "hash": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "createdAt": { "type": "string", "format": "date-time" }, "headless": { "type": "object", "additionalProperties": false, "required": [ "respondentHandoffPath", "answerPath", "capabilityDelivery" ], "properties": { "respondentHandoffPath": { "type": "string" }, "answerPath": { "type": "string" }, "capabilityDelivery": { "type": "string", "const": "show_once_not_replayed" } } }, "transactionId": { "type": "string", "pattern": "^[A-Za-z0-9_-]{43}$" }, "evidence": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "manifestHash", "verificationStatus", "exportRecordId", "workflowStatus" ], "properties": { "schemaVersion": { "type": "string", "const": "ap2-transaction-evidence-v1" }, "manifestHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "verificationStatus": { "type": "string", "const": "passed" }, "exportRecordId": { "type": "string" }, "workflowStatus": { "type": "string", "const": "candidate_not_adopted" } } }, "resolutionAuthorization": { "type": "object", "additionalProperties": false, "required": [ "authorizationId", "authorizationHash", "signingSides" ], "properties": { "authorizationId": { "type": "string" }, "authorizationHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "signingSides": { "type": "array", "prefixItems": [ { "type": "string", "const": "claimant" }, { "type": "string", "const": "respondent" } ], "minItems": 2, "maxItems": 2 } } }, "resolutionLifecycle": { "$ref": "#/components/schemas/ResolutionLifecycleReferenceV1" }, "settlementBinding": { "type": "object", "additionalProperties": false, "required": [ "bindingId", "bindingDigest", "mode", "providerId" ], "properties": { "bindingId": { "type": "string" }, "bindingDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "mode": { "type": "string", "enum": [ "manual_partner", "partner_callback", "platform_adapter" ] }, "providerId": { "type": "string" } } }, "resultPath": { "type": "string" } } }, "ResolutionLifecycleReferenceV1": { "type": "object", "additionalProperties": false, "required": [ "handoffId", "handoffDigest", "frozenRecordDigest" ], "properties": { "handoffId": { "type": "string" }, "handoffDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "frozenRecordDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "UcpResolutionCaseV1": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "caseId", "externalCaseId", "status", "rules", "createdAt", "headless", "transactionId", "evidence", "resolutionAuthorization", "resolutionLifecycle", "settlementBinding", "resultPath" ], "properties": { "schemaVersion": { "type": "string", "const": "ucp-resolution-case-v1" }, "caseId": { "type": "string" }, "externalCaseId": { "type": "string" }, "status": { "type": "string" }, "rules": { "type": "object", "additionalProperties": false, "required": [ "version", "hash" ], "properties": { "version": { "type": "string" }, "hash": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "createdAt": { "type": "string", "format": "date-time" }, "headless": { "type": "object", "additionalProperties": false, "required": [ "respondentHandoffPath", "answerPath", "capabilityDelivery" ], "properties": { "respondentHandoffPath": { "type": "string" }, "answerPath": { "type": "string" }, "capabilityDelivery": { "type": "string", "const": "show_once_not_replayed" } } }, "transactionId": { "type": "string" }, "evidence": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "orderSha256", "frozenRecordDigest", "verificationStatus", "exportRecordId", "workflowStatus" ], "properties": { "schemaVersion": { "type": "string", "const": "verified-ucp-order-evidence-v1" }, "orderSha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "frozenRecordDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "verificationStatus": { "type": "string", "const": "passed" }, "exportRecordId": { "type": "string" }, "workflowStatus": { "type": "string", "const": "candidate_not_adopted" } } }, "resolutionAuthorization": { "type": "object", "additionalProperties": false, "required": [ "authorizationId", "authorizationHash", "signingSides" ], "properties": { "authorizationId": { "type": "string" }, "authorizationHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "signingSides": { "type": "array", "prefixItems": [ { "type": "string", "const": "claimant" }, { "type": "string", "const": "respondent" } ], "minItems": 2, "maxItems": 2 } } }, "resolutionLifecycle": { "$ref": "#/components/schemas/ResolutionLifecycleReferenceV1" }, "settlementBinding": { "type": "object", "additionalProperties": false, "required": [ "bindingId", "bindingDigest", "mode", "providerId" ], "properties": { "bindingId": { "type": "string" }, "bindingDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "mode": { "type": "string", "enum": [ "manual_partner", "partner_callback", "platform_adapter" ] }, "providerId": { "type": "string" } } }, "resultPath": { "type": "string" } } }, "ResolutionResultV1": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "authorizationId", "transactionId", "caseId", "externalCaseId", "awardReference", "review", "authorizedRemedy", "execution", "projectedAt" ], "properties": { "schemaVersion": { "type": "string", "const": "resolution-result-v1" }, "authorizationId": { "type": "string" }, "transactionId": { "type": "string", "pattern": "^[A-Za-z0-9_-]{43}$" }, "caseId": { "type": "string" }, "externalCaseId": { "type": "string" }, "awardReference": { "oneOf": [ { "type": "null" }, { "type": "object", "additionalProperties": false, "required": [ "dispositionId", "awardRevision", "awardHash", "awardArtifactPath", "awardAttestationPath", "recordBundlePath" ], "properties": { "dispositionId": { "type": "string" }, "awardRevision": { "type": "integer", "minimum": 1 }, "awardHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "awardArtifactPath": { "type": "string" }, "awardAttestationPath": { "type": "string" }, "recordBundlePath": { "type": "string" } } } ] }, "review": { "type": "object", "additionalProperties": false, "required": [ "decisionStatus", "finality", "appealEligible", "executionHeldByAppeal", "appealDeadlineAt" ], "properties": { "decisionStatus": { "type": "string", "enum": [ "not_created", "under_review", "served" ] }, "finality": { "type": "string", "enum": [ "not_served", "served", "appealable", "appeal_reserved", "appeal_pending", "final" ] }, "appealEligible": { "type": "boolean" }, "executionHeldByAppeal": { "type": "boolean" }, "appealDeadlineAt": { "type": [ "string", "null" ], "format": "date-time" } } }, "authorizedRemedy": { "oneOf": [ { "type": "null" }, { "type": "object", "additionalProperties": false, "required": [ "outcomeCode", "action", "currency", "amountMinorUnits", "allocations", "bindingDigest" ], "properties": { "outcomeCode": { "type": "string" }, "action": { "type": "string", "enum": [ "release_to_claimant", "release_to_respondent", "allocate_by_award", "none" ] }, "currency": { "type": "string", "const": "USD" }, "amountMinorUnits": { "type": "string", "pattern": "^[1-9][0-9]{0,77}$" }, "allocations": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "recipient", "principalId", "amountMinorUnits" ], "properties": { "recipient": { "type": "string", "enum": [ "claimant", "respondent" ] }, "principalId": { "type": "string" }, "amountMinorUnits": { "type": "string", "pattern": "^(0|[1-9][0-9]{0,77})$" } } } }, "bindingDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } } ] }, "execution": { "description": "Separate from Award finality; failure never creates a confirmation or changes the Award.", "type": "object", "additionalProperties": false, "required": [ "status", "attemptReference", "operationReference", "confirmation", "failureCode" ], "properties": { "status": { "type": "string", "enum": [ "not_ready", "not_requested", "prepared", "submitting", "validated", "manual_action_required", "callback_required", "completed", "failed", "blocked", "unknown_outcome" ] }, "attemptReference": { "type": [ "string", "null" ] }, "operationReference": { "type": [ "string", "null" ] }, "confirmation": { "oneOf": [ { "type": "null" }, { "type": "object", "additionalProperties": false, "required": [ "providerId", "adapter", "receipt", "receiptHash", "confirmedAt" ], "properties": { "providerId": { "type": "string" }, "adapter": { "type": "string" }, "receipt": { "type": "object", "additionalProperties": { "type": "string" } }, "receiptHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "confirmedAt": { "type": "string", "format": "date-time" } } } ] }, "failureCode": { "type": [ "string", "null" ] } } }, "projectedAt": { "type": "string", "format": "date-time" } } }, "FiatMoney": { "type": "object", "additionalProperties": false, "required": [ "currency", "minorUnits" ], "properties": { "currency": { "type": "string", "const": "USD" }, "minorUnits": { "type": "string", "pattern": "^(0|[1-9][0-9]{0,77})$" } } }, "CanonicalCaseEvidenceCollection": { "type": "object", "additionalProperties": true, "required": [ "schemaVersion", "caseId", "evidence" ], "properties": { "schemaVersion": { "type": "string", "const": "case-evidence-v1" }, "caseId": { "type": "string" }, "party": { "type": "string", "enum": [ "claimant", "respondent" ], "description": "The authorized side, when the credential resolves to one." }, "evidence": { "type": "array", "description": "Current caller-visible exhibits.", "items": { "$ref": "#/components/schemas/CanonicalEvidenceObject" } }, "evidenceHistory": { "type": "array", "description": "Caller-visible exhibits including superseded record entries.", "items": { "$ref": "#/components/schemas/CanonicalEvidenceObject" } }, "candidates": { "type": "array", "description": "Partner adoption candidates for the caller's own side. Present only for a partner bearer credential; identical to the evidence-candidates compatibility alias.", "items": { "type": "object", "additionalProperties": true } } } }, "CanonicalEvidenceObject": { "type": "object", "additionalProperties": true, "required": [ "id", "submittedBy", "phase" ], "properties": { "id": { "type": "string" }, "submittedBy": { "type": "string", "enum": [ "claimant", "respondent" ] }, "phase": { "type": "string", "enum": [ "submitted", "exchanged", "admitted", "quarantined", "excluded" ] }, "label": { "type": "string" }, "filename": { "type": "string" }, "mimeType": { "type": "string" }, "sizeBytes": { "type": "integer" }, "contentHash": { "type": "string" }, "revealedAt": { "type": "string", "format": "date-time" } } }, "CanonicalFee": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "feeId", "caseId", "type", "status", "amount" ], "properties": { "schemaVersion": { "type": "string", "const": "fee-v1" }, "feeId": { "type": "string" }, "caseId": { "type": "string" }, "type": { "type": "string", "enum": [ "filing", "appeal", "evaluation" ] }, "status": { "type": "string", "enum": [ "quoted", "payable", "paid", "waived", "cancelled" ] }, "amount": { "$ref": "#/components/schemas/FiatMoney" }, "method": { "type": "string", "enum": [ "x402", "onchain_usdc", "fiat_card", "court_filing_credit", "manual" ] }, "collectionDisposition": { "type": "string" }, "incurredBy": { "type": "string", "description": "The act that incurred the fee, such as filing or appeal_docket." }, "incurredAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time", "description": "Unpaid past this instant, the fee lapses under its own deadline." }, "paidAt": { "type": "string", "format": "date-time" }, "waivedReason": { "type": "string" }, "supplementsFeeId": { "type": "string" }, "checkout": { "type": "object", "additionalProperties": false, "required": [ "method", "httpMethod", "endpoint" ], "description": "Present while the fee is payable.", "properties": { "method": { "type": "string" }, "httpMethod": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } } } } }, "CanonicalFeeCheckoutInput": { "type": "object", "additionalProperties": false, "description": "The fee is selected by the resource path; caseId and feeRecordId in the body are refused.", "properties": { "promotionCode": { "type": "string" }, "priceSelection": { "type": "string", "const": "full" } } }, "CanonicalFeeCheckout": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "feeId", "caseId", "provider", "checkout" ], "properties": { "schemaVersion": { "type": "string", "const": "fee-checkout-v1" }, "feeId": { "type": "string" }, "caseId": { "type": "string" }, "provider": { "type": "string", "enum": [ "stripe", "x402", "court_filing_credit" ] }, "checkout": { "type": "object", "additionalProperties": true, "required": [ "kind" ], "description": "Provider descriptor: a Stripe Checkout session, an applied court filing credit, or the committed x402 payment requirements.", "properties": { "kind": { "type": "string", "enum": [ "stripe_checkout", "credit_applied", "x402_payment_required" ] } } } } }, "PartnerIntegrationIdentity": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "tenant", "integration", "credential" ], "properties": { "schemaVersion": { "type": "string", "const": "partner-integration-v2" }, "tenant": { "type": "object", "additionalProperties": false, "required": [ "id", "slug", "name", "environment", "status" ], "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "environment": { "type": "string", "enum": [ "test", "live" ] }, "status": { "type": "string", "enum": [ "active", "suspended" ] } } }, "integration": { "type": "object", "additionalProperties": false, "required": [ "role", "capabilities", "resourceBinding" ], "properties": { "role": { "type": "string", "enum": [ "platform_orchestrator", "claimant_agent", "respondent_agent", "evidence_exporter", "settlement_adapter", "read_only_observer" ] }, "capabilities": { "type": "array", "uniqueItems": true, "items": { "type": "string", "enum": [ "cases:prepare", "cases:read", "cases:respondent_handoff:read", "callbacks:manage", "settlement:bindings:manage", "messages:write", "evidence:challenges:read", "evidence:challenges:write", "party:claimant:act", "party:respondent:act", "party:claimant:terminate", "party:respondent:terminate", "evidence_exports:notify", "evidence_exports:receipts:read", "settlement:execute" ] } }, "resourceBinding": { "oneOf": [ { "type": "object", "additionalProperties": false, "required": [ "resourceId" ], "properties": { "resourceId": { "type": "string" } } }, { "type": "null" } ] } } }, "credential": { "type": "object", "additionalProperties": false, "required": [ "publicId", "prefix", "createdAt", "expiresAt" ], "properties": { "publicId": { "type": "string" }, "prefix": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": [ "string", "null" ], "format": "date-time" } } } } }, "PartnerIntegrationIdentityEnvelope": { "type": "object", "additionalProperties": false, "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/PartnerIntegrationIdentity" }, "requestId": { "type": "string" } } }, "AuthorityGrantRegistration": { "type": "object", "additionalProperties": false, "required": [ "claimantPrincipalId", "externalCaseId", "transactionId", "allowedActs", "maximumAmount", "evidenceSource", "artifactRefs", "artifactHashes", "expiresAt" ], "properties": { "claimantPrincipalId": { "type": "string", "minLength": 1, "maxLength": 200 }, "externalCaseId": { "type": "string", "minLength": 1, "maxLength": 200 }, "transactionId": { "type": "string", "minLength": 1, "maxLength": 200 }, "allowedActs": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "file_dispute", "submit_evidence", "file_appeal", "answer_appeal", "file_post_award_request", "report_execution", "manage_representatives", "report_processing_defect", "file_procedural_request" ] } }, "maximumAmount": { "allOf": [ { "$ref": "#/components/schemas/FiatMoney" } ], "description": "Positive USD cents from 1 through 9007199254740991 inclusive; zero and larger values are rejected." }, "evidenceSource": { "type": "string", "minLength": 1, "maxLength": 500 }, "artifactRefs": { "type": "array", "minItems": 1, "maxItems": 20, "items": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "artifactHashes": { "type": "array", "minItems": 1, "maxItems": 20, "items": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "expiresAt": { "type": "string", "format": "date-time", "example": "2026-12-01T00:00:00.000Z" } } }, "ConsentArtifactRegistration": { "type": "object", "additionalProperties": false, "required": [ "party", "principalId", "counterpartyId", "transactionId", "scope", "rulesVersion", "termsVersion", "termsHash", "artifactRef", "artifactHash", "method", "acceptedAt" ], "properties": { "party": { "type": "string", "enum": [ "claimant", "respondent" ] }, "principalId": { "type": "string", "minLength": 1, "maxLength": 200 }, "counterpartyId": { "type": "string", "minLength": 1, "maxLength": 200 }, "transactionId": { "type": "string", "minLength": 1, "maxLength": 200 }, "scope": { "type": "string", "minLength": 1, "maxLength": 2000 }, "rulesVersion": { "type": "string", "minLength": 1, "maxLength": 100, "example": "1.0", "x-current-rules-version": true }, "termsVersion": { "type": "string", "minLength": 1, "maxLength": 100 }, "termsHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "artifactRef": { "type": "string", "minLength": 1, "maxLength": 1000 }, "artifactHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "method": { "type": "string", "enum": [ "signed_doc", "email_attest", "api_acceptance" ] }, "acceptedAt": { "type": "string", "format": "date-time", "example": "2026-08-18T00:00:00.000Z" }, "expiresAt": { "type": "string", "format": "date-time", "example": "2026-12-01T00:00:00.000Z" }, "filingDraftId": { "type": "string", "description": "Required for api_acceptance. termsHash must match the prepared packet. Existing registered authority must bind this credential to that principal." } }, "allOf": [ { "if": { "properties": { "method": { "const": "api_acceptance" } }, "required": [ "method" ] }, "then": { "required": [ "filingDraftId" ] } } ] }, "AuthorizationRegistrationProvenance": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "credentialPublicId", "role", "requestHash", "registeredAt" ], "properties": { "schemaVersion": { "type": "string", "const": "partner-authorization-registration-v2" }, "credentialPublicId": { "type": "string" }, "role": { "type": "string", "enum": [ "claimant_agent", "respondent_agent" ] }, "requestHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "registeredAt": { "type": "string", "format": "date-time" } } }, "ClaimantAuthorizationRegistrationProvenance": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "credentialPublicId", "role", "requestHash", "registeredAt" ], "properties": { "schemaVersion": { "type": "string", "const": "partner-authorization-registration-v2" }, "credentialPublicId": { "type": "string" }, "role": { "type": "string", "const": "claimant_agent" }, "requestHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "registeredAt": { "type": "string", "format": "date-time" } } }, "AuthorityGrantRegistrationResult": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "authorityGrantId", "claimantPrincipalId", "externalCaseId", "transactionId", "allowedActs", "maximumAmount", "expiresAt", "registeredBy" ], "properties": { "schemaVersion": { "type": "string", "const": "partner-authority-grant-v2" }, "authorityGrantId": { "type": "string" }, "claimantPrincipalId": { "type": "string" }, "externalCaseId": { "type": "string" }, "transactionId": { "type": "string" }, "allowedActs": { "type": "array", "items": { "type": "string", "enum": [ "file_dispute", "submit_evidence", "file_appeal", "answer_appeal", "file_post_award_request", "report_execution", "manage_representatives", "report_processing_defect", "file_procedural_request" ] } }, "maximumAmount": { "$ref": "#/components/schemas/FiatMoney" }, "expiresAt": { "type": "string", "format": "date-time" }, "registeredBy": { "$ref": "#/components/schemas/ClaimantAuthorizationRegistrationProvenance" } } }, "AuthorityGrantRegistrationEnvelope": { "type": "object", "additionalProperties": false, "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/AuthorityGrantRegistrationResult" }, "requestId": { "type": "string" } } }, "ConsentArtifactRegistrationResult": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "consentArtifactId", "party", "principalId", "counterpartyId", "transactionId", "scope", "rulesVersion", "termsVersion", "acceptedAt", "expiresAt", "registeredBy" ], "properties": { "schemaVersion": { "type": "string", "const": "partner-consent-artifact-v2" }, "consentArtifactId": { "type": "string" }, "party": { "type": "string", "enum": [ "claimant", "respondent" ] }, "principalId": { "type": "string" }, "counterpartyId": { "type": "string" }, "transactionId": { "type": "string" }, "scope": { "type": "string" }, "rulesVersion": { "type": "string" }, "termsVersion": { "type": "string" }, "acceptedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": [ "string", "null" ], "format": "date-time" }, "registeredBy": { "$ref": "#/components/schemas/AuthorizationRegistrationProvenance" }, "termsDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "filingDraftId": { "type": "string" } } }, "ConsentArtifactRegistrationEnvelope": { "type": "object", "additionalProperties": false, "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/ConsentArtifactRegistrationResult" }, "requestId": { "type": "string" } } }, "EvidenceCandidateList": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "caseId", "party", "candidates" ], "properties": { "schemaVersion": { "type": "string", "const": "evidence-candidates-v2" }, "caseId": { "type": "string" }, "party": { "type": "string", "enum": [ "claimant", "respondent" ] }, "candidates": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "exportRecordId", "sourcePartnerId", "adopterPartnerId", "externalExportId", "exportVersion", "receivedAt", "superseded", "artifacts" ], "properties": { "exportRecordId": { "type": "string" }, "sourcePartnerId": { "type": "string" }, "adopterPartnerId": { "type": "string" }, "externalExportId": { "type": "string" }, "exportVersion": { "type": "integer", "minimum": 1 }, "receivedAt": { "type": "string", "format": "date-time" }, "superseded": { "type": "boolean" }, "artifacts": { "type": "array", "items": { "type": "object", "additionalProperties": true, "required": [ "artifactRef", "contentType", "byteLength", "sha256", "adoptable", "adoptedByThisParty" ], "properties": { "artifactRef": { "type": "string" }, "contentType": { "type": "string" }, "byteLength": { "type": "integer", "minimum": 0 }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "adoptable": { "type": "boolean" }, "adoptedByThisParty": { "type": "boolean" } } } } } } } } }, "PrepareFiling": { "type": "object", "additionalProperties": false, "allOf": [ { "not": { "required": [ "feeReferralAuthorizationId", "sponsorshipReferralId" ] } } ], "required": [ "externalCaseId", "transactionId", "policyVersion", "authorityGrantId", "consentArtifactIds", "summary", "claimAmount", "parties", "claim" ], "properties": { "externalCaseId": { "type": "string" }, "transactionId": { "type": "string" }, "policyVersion": { "type": "string" }, "authorityGrantId": { "type": "string" }, "consentArtifactIds": { "$ref": "#/components/schemas/ConsentArtifactIds" }, "summary": { "type": "string" }, "backgroundFacts": { "type": "string" }, "claimAmount": { "$ref": "#/components/schemas/FiatMoney" }, "parties": { "$ref": "#/components/schemas/CasePartiesInput" }, "claim": { "$ref": "#/components/schemas/ClaimInput" }, "feeReferralAuthorizationId": { "type": "string", "description": "Neutral agreement-derived fee referral. Mutually exclusive with sponsorshipReferralId." }, "sponsorshipReferralId": { "type": "string", "deprecated": true, "description": "Legacy fixed-$5 sponsorship referral. Mutually exclusive with feeReferralAuthorizationId." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } }, "claimantAcceptanceIdentity": { "description": "Optional packet identity. When omitted, existing partner consent and hosted respondent behavior apply; no hosted claimant acceptance link is issued. Canonical filings require this identity.", "$ref": "#/components/schemas/ClaimantAcceptanceIdentity" } } }, "FilingConfirmation": { "type": "object", "additionalProperties": false, "required": [ "draftDigest", "confirmationStatement", "actorId", "principalId", "confirmationMethod", "confirmationReference" ], "properties": { "draftDigest": { "type": "string", "minLength": 1, "maxLength": 64 }, "confirmationStatement": { "type": "string", "minLength": 1, "maxLength": 1000 }, "actorId": { "type": "string", "minLength": 1, "maxLength": 200, "description": "Must equal the immutable claimant authority agent ID." }, "principalId": { "type": "string", "minLength": 1, "maxLength": 200 }, "confirmationMethod": { "type": "string", "const": "protocol_act" }, "confirmationReference": { "type": "string", "minLength": 1, "maxLength": 500 }, "acceptance": { "$ref": "#/components/schemas/FilingAcceptanceProof" } } }, "MembershipAnswer": { "type": "object", "additionalProperties": false, "required": [ "protocolActor", "protocolPrincipal", "protocolSource", "position" ], "properties": { "protocolActor": { "type": "string", "minLength": 1, "pattern": "\\S", "description": "Must equal the active respondent membership agent ID, or the authenticated credential public ID when the membership has no immutable agent." }, "protocolPrincipal": { "type": "string", "minLength": 1, "pattern": "\\S" }, "protocolSource": { "type": "string", "minLength": 1, "pattern": "\\S" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "human", "entity", "agent" ] }, "position": { "type": "string", "minLength": 1, "maxLength": 20000, "pattern": "\\S" }, "evidence": { "type": "array", "items": { "type": "string" } }, "relief": { "type": "string", "maxLength": 2000 }, "declaratoryRelief": { "type": "string", "maxLength": 4000, "pattern": "^\\s*$|^\\s*[Dd][Ee][Cc][Ll][Aa][Rr][Ee]\\s+[Tt][Hh][Aa][Tt]\\s+\\S" }, "orderRelief": { "type": "string", "maxLength": 4000, "description": "Fixed-order request. Requires the case’s confirmed-request inventory procedure; historical cases retain their pinned procedure." }, "hasPrincipal": { "type": "boolean" }, "principalCompressedClockConsent": { "type": "boolean" } } }, "WalletInviteAnswer": { "type": "object", "additionalProperties": false, "required": [ "inviteToken", "walletAddress", "signature", "position" ], "properties": { "inviteToken": { "type": "string", "minLength": 1 }, "walletAddress": { "type": "string", "pattern": "^0x[A-Fa-f0-9]{40}$" }, "signature": { "type": "string", "pattern": "^0x[A-Fa-f0-9]{130}$" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "human", "entity", "agent" ] }, "position": { "type": "string", "minLength": 1, "maxLength": 20000, "pattern": "\\S" }, "evidence": { "type": "array", "items": { "type": "string" } }, "relief": { "type": "string", "maxLength": 2000 }, "declaratoryRelief": { "type": "string", "maxLength": 4000, "pattern": "^\\s*$|^\\s*[Dd][Ee][Cc][Ll][Aa][Rr][Ee]\\s+[Tt][Hh][Aa][Tt]\\s+\\S" }, "orderRelief": { "type": "string", "maxLength": 4000, "description": "Fixed-order request. Requires the case’s confirmed-request inventory procedure; historical cases retain their pinned procedure." }, "hasPrincipal": { "type": "boolean" }, "principalCompressedClockConsent": { "type": "boolean" } } }, "Answer": { "oneOf": [ { "$ref": "#/components/schemas/MembershipAnswer" }, { "$ref": "#/components/schemas/WalletInviteAnswer" } ] }, "TerminationRequestInput": { "type": "object", "additionalProperties": false, "required": [ "action", "expectedRevision" ], "properties": { "action": { "type": "string", "enum": [ "request", "cancel_request" ] }, "expectedRevision": { "type": "integer", "minimum": 0 }, "requestId": { "type": "string", "description": "Required when action is cancel_request." }, "adoption": { "$ref": "#/components/schemas/RulesAdoptionAssent" }, "externalProtocolReference": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,200}$", "description": "Required when action is request; identifies the agent protocol act without exposing settlement terms." } } }, "RulesAdoptionAssent": { "type": "object", "additionalProperties": false, "required": [ "version", "hash", "statementVersion" ], "properties": { "version": { "type": "string" }, "hash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "statementVersion": { "type": "string", "const": "rule_1_3_adoption_v1" } } }, "PreAwardTermination": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "id", "kind", "status", "initiatedBySide", "initiatedAt", "confirmations", "fundsEffect" ], "properties": { "schemaVersion": { "type": "string", "const": "pre-award-termination-v1" }, "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "claimant_withdrawal", "party_agreement" ] }, "status": { "type": "string", "enum": [ "pending", "completed", "cancelled", "superseded" ] }, "initiatedBySide": { "type": "string", "enum": [ "claimant", "respondent" ] }, "initiatedAt": { "type": "string", "format": "date-time" }, "confirmations": { "type": "array", "maxItems": 2, "items": { "type": "object", "additionalProperties": false, "required": [ "side", "confirmedAt" ], "properties": { "side": { "type": "string", "enum": [ "claimant", "respondent" ] }, "confirmedAt": { "type": "string", "format": "date-time" } } } }, "completedAt": { "type": "string", "format": "date-time" }, "cancelledAt": { "type": "string", "format": "date-time" }, "fundsEffect": { "type": "string", "const": "none" }, "adoptsRulesVersion": { "type": "string" }, "adoptsRulesHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "PreAwardTerminationResponse": { "type": "object", "additionalProperties": false, "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "additionalProperties": false, "required": [ "caseId", "caseStatus", "revision", "termination" ], "properties": { "caseId": { "type": "string" }, "caseStatus": { "type": "string" }, "revision": { "type": "integer", "minimum": 0 }, "termination": { "$ref": "#/components/schemas/PreAwardTermination" }, "deadlinesContinue": { "type": "boolean" } } }, "requestId": { "type": "string" } } }, "EvidenceExportNotification": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "eventId", "eventType", "occurredAt", "exporterId", "specVersion", "exportId", "exportVersion", "bundleHash", "contentType", "byteLength", "downloadUrl", "downloadExpiresAt", "match" ], "properties": { "schemaVersion": { "type": "string", "const": "evidence-export-notification-v1" }, "eventId": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,160}$" }, "eventType": { "type": "string", "const": "evidence.bundle.available" }, "occurredAt": { "type": "string", "format": "date-time", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\\.[0-9]{3}Z$" }, "exporterId": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,200}$" }, "specVersion": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,200}$" }, "exportId": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,200}$" }, "exportVersion": { "type": "integer", "minimum": 1 }, "supersedes": { "type": "object", "additionalProperties": false, "required": [ "exportId", "exportVersion", "sha256" ], "properties": { "exportId": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,200}$" }, "exportVersion": { "type": "integer", "minimum": 1 }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "bundleHash": { "type": "object", "additionalProperties": false, "required": [ "algorithm", "value" ], "properties": { "algorithm": { "type": "string", "const": "sha256" }, "value": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "contentType": { "type": "string", "const": "application/json" }, "byteLength": { "type": "integer", "minimum": 1, "maximum": 10485760 }, "downloadUrl": { "type": "string", "format": "uri", "maxLength": 2048, "pattern": "^https://(?![^/?#]*@)(?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?\\.)*[A-Za-z](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?(?::(?:0|[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]))?(?:[/?][^#\\s]*)?$", "description": "HTTPS URL with a conventional DNS hostname whose final label begins with an ASCII letter, an optional canonical decimal port from 0 through 65535, and no user information or fragment. IP literals and other WHATWG normalization forms are intentionally outside this conservative published schema; runtime URL parsing remains authoritative." }, "downloadExpiresAt": { "type": "string", "format": "date-time", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\\.[0-9]{3}Z$" }, "match": { "type": "object", "additionalProperties": false, "minProperties": 1, "properties": { "externalCaseId": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,200}$" }, "transactionId": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,200}$" }, "merchantId": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,200}$" }, "network": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,200}$" }, "transactionHash": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,200}$" } } }, "retention": { "type": "object", "additionalProperties": false, "properties": { "profileId": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,200}$" }, "sourceRetentionUntil": { "type": "string", "format": "date-time", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\\.[0-9]{3}Z$" }, "sourceLegalHoldActive": { "type": "boolean" } } } } }, "EvidenceIngestReceipt": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "id", "partnerId", "exporterId", "eventId", "exportId", "exportVersion", "bundleHash", "status", "receivedAt", "verificationStatus" ], "properties": { "schemaVersion": { "type": "string", "const": "evidence-ingest-receipt-v1" }, "id": { "type": "string" }, "partnerId": { "type": "string" }, "exporterId": { "type": "string" }, "eventId": { "type": "string" }, "exportId": { "type": "string" }, "exportVersion": { "type": "integer", "minimum": 1 }, "bundleHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "status": { "type": "string", "enum": [ "accepted", "quarantined", "rejected", "duplicate" ] }, "receivedAt": { "type": "string", "format": "date-time" }, "verificationStatus": { "type": "string", "enum": [ "passed", "passed_with_warnings", "failed", "not_run" ] }, "exportRecordId": { "type": "string" }, "detailCode": { "type": "string", "description": "New bundle validation failures use bundle_parse_failed. Historical receipts may contain invalid_notification; they remain unchanged on reads and replay.", "enum": [ "invalid_notification", "unregistered_origin", "download_expired", "invalid_supersession", "retention_profile_unavailable", "download_failed", "download_origin_blocked", "download_redirect_refused", "download_oversized", "content_type_mismatch", "byte_length_mismatch", "digest_mismatch", "bundle_parse_failed", "unsupported_case_match", "incomplete_case_match", "ambiguous_case_match", "attestation_missing", "attestation_malformed", "attestation_coverage_invalid", "attestation_key_unknown", "attestation_key_unusable", "attestation_digest_mismatch", "attestation_context_mismatch", "attestation_time_invalid", "attestation_signature_invalid" ] }, "validationError": { "type": "object", "additionalProperties": false, "description": "Optional parser-authored diagnostic for a bundle validation failure. Field paths refer to the outer evidence-bundle-v1 envelope, with $ denoting its root. Contains no rejected values; absent on historical receipts and unrelated failure types.", "required": [ "field", "message" ], "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 200 }, "message": { "type": "string", "minLength": 1, "maxLength": 500 } } }, "verificationProfile": { "type": "string", "const": "acomm-attestation-ed25519-v1" }, "attestationsVerified": { "type": "integer", "minimum": 1 }, "attestationTrustBasis": { "type": "string", "enum": [ "synthetic_same_channel", "authenticated_out_of_band" ] } } }, "EvidenceIngestReceiptEnvelope": { "type": "object", "additionalProperties": false, "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "additionalProperties": false, "required": [ "receipt" ], "properties": { "receipt": { "$ref": "#/components/schemas/EvidenceIngestReceipt" } } }, "requestId": { "type": "string" } } }, "CanonicalComplaintClaim": { "type": "object", "additionalProperties": false, "required": [ "statement", "requestedOutcome" ], "properties": { "statement": { "type": "string" }, "requestedOutcome": { "type": "string", "enum": [ "refund", "release", "split", "other" ] }, "requestedItems": { "type": "array", "minItems": 1, "maxItems": 20, "description": "Optional typed operative requests, digest-bound with stable IDs. At most one monetary item uses claimAmount. Declaratory and fixed-order text is supplied directly by the party.", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "kind", "text" ], "properties": { "id": { "type": "string", "pattern": "^[MDO][1-9][0-9]{0,5}$" }, "kind": { "type": "string", "enum": [ "monetary", "declaratory", "order" ] }, "text": { "type": "string", "minLength": 1, "maxLength": 4000 } } } } } }, "CreateCaseDraft": { "type": "object", "additionalProperties": false, "required": [ "externalCaseId", "transactionId", "policyVersion", "authorityGrantId", "consentArtifactIds", "claimAmount", "parties", "intakeMode", "confirmationPolicy" ], "properties": { "caseMode": { "type": "string", "enum": [ "proceeding", "evaluation" ], "default": "proceeding" }, "externalCaseId": { "type": "string" }, "transactionId": { "type": "string" }, "policyVersion": { "type": "string" }, "authorityGrantId": { "type": "string" }, "consentArtifactIds": { "$ref": "#/components/schemas/CaseDraftConsentArtifactIds" }, "claimAmount": { "$ref": "#/components/schemas/FiatMoney" }, "parties": { "$ref": "#/components/schemas/CasePartiesInput" }, "summary": { "type": "string" }, "backgroundFacts": { "type": "string" }, "claim": { "$ref": "#/components/schemas/CanonicalComplaintClaim" }, "feeReferralAuthorizationId": { "type": "string", "description": "Neutral agreement-derived fee referral. Mutually exclusive with sponsorshipReferralId." }, "sponsorshipReferralId": { "type": "string", "deprecated": true, "description": "Legacy fixed-$5 sponsorship referral. Mutually exclusive with feeReferralAuthorizationId." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } }, "intakeMode": { "type": "string", "enum": [ "claimant_initiated", "claimant_proposed", "bilateral_api", "bundled_bilateral" ] }, "confirmationPolicy": { "type": "object", "additionalProperties": false, "required": [ "mode" ], "properties": { "mode": { "type": "string", "enum": [ "initiator_only", "all_participants", "bundled_authorizations" ] } } }, "procedure": { "$ref": "#/components/schemas/CaseProcedure" }, "evaluation": { "$ref": "#/components/schemas/NarrowEvaluationDefinitionInput" }, "participants": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "object", "additionalProperties": false, "required": [ "side" ], "properties": { "side": { "type": "string", "enum": [ "claimant", "respondent" ] }, "partnerId": { "type": "string", "description": "Required for API-authorized participants. Omit it for the hosted respondent in claimant_initiated mode." }, "agentId": { "type": "string" } } } }, "claimantAcceptanceIdentity": { "description": "Optional packet identity. When omitted, existing partner consent and hosted respondent behavior apply; no hosted claimant acceptance link is issued. Canonical filings require this identity.", "$ref": "#/components/schemas/ClaimantAcceptanceIdentity" } }, "allOf": [ { "not": { "required": [ "feeReferralAuthorizationId", "sponsorshipReferralId" ] } }, { "oneOf": [ { "title": "Claimant initiates and respondent may consent later", "properties": { "intakeMode": { "type": "string", "const": "claimant_initiated" } }, "oneOf": [ { "title": "Hosted respondent consents after opening", "properties": { "consentArtifactIds": { "$ref": "#/components/schemas/ClaimantOnlyConsentArtifactIds" }, "participants": { "$ref": "#/components/schemas/HostedCaseDraftParticipants" } } }, { "title": "Respondent consent was registered in advance", "properties": { "consentArtifactIds": { "$ref": "#/components/schemas/ConsentArtifactIds" } } } ] }, { "title": "Bilaterally authorized or claimant-proposed case", "properties": { "intakeMode": { "type": "string", "enum": [ "claimant_proposed", "bilateral_api", "bundled_bilateral" ] }, "consentArtifactIds": { "$ref": "#/components/schemas/ConsentArtifactIds" } } } ] } ], "oneOf": [ { "title": "Proceeding case", "required": [ "summary", "claim" ], "properties": { "caseMode": { "type": "string", "const": "proceeding" } } }, { "title": "Narrow evaluation case", "required": [ "caseMode", "evaluation" ], "properties": { "caseMode": { "type": "string", "const": "evaluation" } } } ] }, "ConsentArtifactIds": { "type": "object", "additionalProperties": false, "required": [ "respondent" ], "properties": { "claimant": { "type": "string" }, "respondent": { "type": "string" } } }, "CaseSponsorshipReferralInput": { "type": "object", "additionalProperties": false, "required": [ "externalCaseId", "externalTransactionId", "intendedParties", "feeType" ], "properties": { "externalCaseId": { "type": "string", "minLength": 1, "maxLength": 200 }, "externalTransactionId": { "type": "string", "minLength": 1, "maxLength": 200 }, "intendedParties": { "type": "object", "additionalProperties": false, "required": [ "claimantExternalId", "respondentExternalId" ], "properties": { "claimantExternalId": { "type": "string", "minLength": 1, "maxLength": 200 }, "respondentExternalId": { "type": "string", "minLength": 1, "maxLength": 200 } } }, "feeType": { "type": "string", "const": "filing" } } }, "PartnerFeeReferralInput": { "type": "object", "additionalProperties": false, "required": [ "externalCaseId", "externalReferralId", "intendedParties", "feeType" ], "properties": { "externalCaseId": { "type": "string", "minLength": 1, "maxLength": 200 }, "externalReferralId": { "type": "string", "minLength": 1, "maxLength": 200, "description": "Partner-unique referral identity that does not depend on a payment transaction." }, "externalTransactionId": { "type": "string", "minLength": 1, "maxLength": 200, "description": "Optional marketplace transaction provenance." }, "intendedParties": { "type": "object", "additionalProperties": false, "required": [ "claimantExternalId", "respondentExternalId" ], "properties": { "claimantExternalId": { "type": "string", "minLength": 1, "maxLength": 200 }, "respondentExternalId": { "type": "string", "minLength": 1, "maxLength": 200 } } }, "feeType": { "type": "string", "const": "filing" } } }, "PartnerFeeReferral": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "feeReferralAuthorizationId", "externalCaseId", "externalReferralId", "feeType", "status", "expiresAt" ], "properties": { "schemaVersion": { "type": "string", "const": "partner-fee-referral-authorization-v1" }, "feeReferralAuthorizationId": { "type": "string" }, "externalCaseId": { "type": "string" }, "externalReferralId": { "type": "string" }, "externalTransactionId": { "type": "string" }, "feeType": { "type": "string", "const": "filing" }, "status": { "type": "string", "const": "accepted" }, "expiresAt": { "type": "string", "format": "date-time" } } }, "PartnerFeeReferralEnvelope": { "type": "object", "additionalProperties": false, "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/PartnerFeeReferral" }, "requestId": { "type": "string" } } }, "PartnerFilingCheckoutInput": { "type": "object", "additionalProperties": false, "required": [ "caseId" ], "properties": { "caseId": { "type": "string", "pattern": "^pcase_[A-Za-z0-9_-]{1,96}$", "description": "Public Partner API case ID owned by the authenticated partner." } } }, "PartnerFilingCheckout": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "caseId", "checkout" ], "properties": { "schemaVersion": { "type": "string", "const": "partner-filing-checkout-v1" }, "caseId": { "type": "string", "pattern": "^pcase_[A-Za-z0-9_-]{1,96}$" }, "checkout": { "type": "object", "additionalProperties": false, "required": [ "id", "url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string", "format": "uri" } } } } }, "PartnerFilingCheckoutEnvelope": { "type": "object", "additionalProperties": false, "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/PartnerFilingCheckout" }, "requestId": { "type": "string" } } }, "CaseSponsorshipReferral": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "referralAuthorizationId", "externalCaseId", "externalTransactionId", "feeType", "status", "expiresAt" ], "properties": { "schemaVersion": { "type": "string", "const": "case-referral-authorization-v1" }, "referralAuthorizationId": { "type": "string" }, "externalCaseId": { "type": "string" }, "externalTransactionId": { "type": "string" }, "feeType": { "type": "string", "const": "filing" }, "status": { "type": "string", "const": "accepted" }, "expiresAt": { "type": "string", "format": "date-time" } } }, "CaseSponsorshipReferralEnvelope": { "type": "object", "additionalProperties": false, "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/CaseSponsorshipReferral" }, "requestId": { "type": "string" } } }, "SponsorshipFeeCoverage": { "type": "object", "additionalProperties": false, "required": [ "referralAuthorizationId", "status", "sponsorDisplayName", "feeAmount", "partyAmountDue", "agreementVersion", "agreementHash", "billableEvent" ], "properties": { "referralAuthorizationId": { "type": "string" }, "status": { "type": "string", "enum": [ "covered", "settled" ] }, "sponsorDisplayName": { "type": "string" }, "feeAmount": { "$ref": "#/components/schemas/FiatMoney" }, "partyAmountDue": { "$ref": "#/components/schemas/FiatMoney" }, "agreementVersion": { "type": "integer", "minimum": 1 }, "agreementHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "billableEvent": { "type": "string", "const": "case_docketed" } } }, "PartnerFeeDisposition": { "type": "object", "additionalProperties": false, "required": [ "feeReferralAuthorizationId", "assessedFee", "partyAmountDue", "collectionDisposition", "label", "agreementVersion", "agreementHash" ], "properties": { "feeReferralAuthorizationId": { "type": "string" }, "assessedFee": { "$ref": "#/components/schemas/FiatMoney" }, "partyAmountDue": { "$ref": "#/components/schemas/FiatMoney" }, "collectionDisposition": { "type": "string", "enum": [ "party_due", "party_paid", "partner_covered_per_case", "partner_covered_by_plan", "forum_waived", "cancelled" ] }, "label": { "type": "string" }, "agreementVersion": { "type": "integer", "minimum": 1 }, "agreementHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "PartnerFeeCheckoutChallenge": { "type": "object", "additionalProperties": false, "required": [ "method", "amount", "caseId", "checkoutEndpoint", "httpMethod", "requestBody", "authorization" ], "properties": { "method": { "type": "string", "const": "fiat_card" }, "amount": { "$ref": "#/components/schemas/FiatMoney" }, "caseId": { "type": "string", "description": "Public Partner API case ID accepted by checkoutEndpoint." }, "checkoutEndpoint": { "type": "string", "const": "/api/v2/fees/stripe/checkout" }, "httpMethod": { "type": "string", "const": "POST" }, "requestBody": { "$ref": "#/components/schemas/PartnerFilingCheckoutInput" }, "authorization": { "type": "string", "const": "partner_bearer" } } }, "CaseDraftConsentArtifactIds": { "type": "object", "additionalProperties": false, "properties": { "claimant": { "type": "string" }, "respondent": { "type": "string", "description": "May be omitted only for claimant_initiated; the respondent then accepts the immutable case terms in the hosted flow." } } }, "ClaimantOnlyConsentArtifactIds": { "type": "object", "additionalProperties": false, "properties": { "claimant": { "type": "string" } } }, "HostedCaseDraftParticipants": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "oneOf": [ { "type": "object", "additionalProperties": false, "required": [ "side" ], "properties": { "side": { "type": "string", "const": "claimant" }, "partnerId": { "type": "string" }, "agentId": { "type": "string" } } }, { "type": "object", "additionalProperties": false, "required": [ "side" ], "properties": { "side": { "type": "string", "const": "respondent" } } } ] } }, "CasePartyInput": { "type": "object", "additionalProperties": false, "required": [ "externalId", "name" ], "properties": { "externalId": { "type": "string" }, "name": { "type": "string" } } }, "CasePartiesInput": { "type": "object", "additionalProperties": false, "required": [ "claimant", "respondent" ], "properties": { "claimant": { "$ref": "#/components/schemas/CasePartyInput" }, "respondent": { "$ref": "#/components/schemas/CasePartyInput" } } }, "ClaimInput": { "type": "object", "additionalProperties": false, "required": [ "statement", "requestedOutcome" ], "properties": { "statement": { "type": "string" }, "requestedOutcome": { "type": "string", "enum": [ "refund", "release", "split", "other" ] } } }, "CaseProcedure": { "type": "object", "additionalProperties": false, "required": [ "profile" ], "properties": { "profile": { "type": "string", "enum": [ "standard", "fast", "single_round", "joint_record", "evaluation", "custom_bounded" ] }, "answerRequired": { "type": "boolean" }, "evidenceRounds": { "type": "integer", "minimum": 1, "maximum": 3 }, "rebuttalRounds": { "type": "integer", "minimum": 0, "maximum": 3 }, "filingsPerSidePerStage": { "type": "integer", "minimum": 1, "maximum": 3 }, "recordConfirmationRequired": { "type": "boolean", "const": true } } }, "NarrowEvaluationCriterion": { "type": "object", "additionalProperties": false, "required": [ "id", "text" ], "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, "text": { "type": "string", "minLength": 1, "maxLength": 1000 } } }, "NarrowEvaluationOutcome": { "type": "object", "additionalProperties": false, "required": [ "code", "settlementAction" ], "properties": { "code": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "settlementAction": { "type": "object", "additionalProperties": false, "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "release_to_claimant", "release_to_respondent", "allocate_by_award", "none" ] } } } } }, "NarrowEvaluationDefinitionInput": { "type": "object", "additionalProperties": false, "required": [ "externalEvaluationId", "question", "allowedOutcomes" ], "properties": { "externalEvaluationId": { "type": "string", "minLength": 1, "maxLength": 200 }, "question": { "type": "object", "additionalProperties": false, "required": [ "text", "criteria" ], "properties": { "text": { "type": "string", "minLength": 1, "maxLength": 2000 }, "criteria": { "type": "array", "minItems": 1, "maxItems": 20, "items": { "$ref": "#/components/schemas/NarrowEvaluationCriterion" } } } }, "allowedOutcomes": { "type": "array", "minItems": 3, "maxItems": 3, "description": "Exactly three outcomes are required; indeterminate must be the single outcome mapped to none. The other outcomes may use full release or exact Award allocation.", "items": { "$ref": "#/components/schemas/NarrowEvaluationOutcome" } }, "evidencePolicy": { "$ref": "#/components/schemas/NarrowEvaluationEvidencePolicyInput" }, "reviewPolicy": { "$ref": "#/components/schemas/NarrowEvaluationReviewPolicyInput" } } }, "CaseDraftEvaluationDefinition": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "externalEvaluationId", "evaluationDigest", "question", "allowedOutcomes", "evidencePolicy", "reviewPolicy" ], "properties": { "schemaVersion": { "type": "string", "const": "narrow-evaluation-v2" }, "externalEvaluationId": { "type": "string" }, "evaluationDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "question": { "type": "object", "additionalProperties": false, "required": [ "text", "criteria" ], "properties": { "text": { "type": "string" }, "criteria": { "type": "array", "items": { "$ref": "#/components/schemas/NarrowEvaluationCriterion" } } } }, "allowedOutcomes": { "type": "array", "items": { "$ref": "#/components/schemas/NarrowEvaluationOutcome" } }, "evidencePolicy": { "$ref": "#/components/schemas/NarrowEvaluationEvidencePolicy" }, "reviewPolicy": { "$ref": "#/components/schemas/NarrowEvaluationReviewPolicy" } } }, "NarrowEvaluationEvidencePolicyInput": { "type": "object", "additionalProperties": false, "properties": { "sources": { "type": "array", "minItems": 1, "maxItems": 2, "uniqueItems": true, "items": { "type": "string", "enum": [ "party_submissions", "evidence_export_candidates" ] } }, "additionalPartyEvidence": { "type": "boolean", "const": true, "default": true } } }, "NarrowEvaluationReviewPolicyInput": { "type": "object", "additionalProperties": false, "properties": { "initialPath": { "type": "string", "const": "adjudicative", "default": "adjudicative" }, "humanReviewRequired": { "type": "boolean", "const": false, "default": false } } }, "NarrowEvaluationEvidencePolicy": { "type": "object", "additionalProperties": false, "required": [ "sources", "additionalPartyEvidence" ], "properties": { "sources": { "type": "array", "minItems": 1, "maxItems": 2, "uniqueItems": true, "items": { "type": "string", "enum": [ "party_submissions", "evidence_export_candidates" ] } }, "additionalPartyEvidence": { "type": "boolean", "const": true } } }, "NarrowEvaluationReviewPolicy": { "type": "object", "additionalProperties": false, "required": [ "initialPath", "humanReviewRequired" ], "properties": { "initialPath": { "type": "string", "const": "adjudicative" }, "humanReviewRequired": { "type": "boolean", "const": false } } }, "NarrowEvaluationRecord": { "type": "object", "additionalProperties": false, "required": [ "status" ], "properties": { "phase": { "type": "string", "enum": [ "evidence", "close", "merits" ] }, "status": { "type": "string", "enum": [ "open", "frozen" ] } } }, "NarrowEvaluationCriterionFinding": { "type": "object", "additionalProperties": false, "required": [ "criterionId", "status", "finding", "confidence" ], "properties": { "criterionId": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, "status": { "type": "string", "enum": [ "satisfied", "not_satisfied", "indeterminate" ] }, "finding": { "type": "string" }, "confidence": { "type": "number", "minimum": 0, "maximum": 1 } } }, "NarrowEvaluationAwardReference": { "type": "object", "additionalProperties": false, "required": [ "dispositionId", "awardHash", "resourcePath" ], "properties": { "dispositionId": { "type": "string" }, "awardHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "releasedAt": { "type": "string", "format": "date-time" }, "resourcePath": { "type": "string" } } }, "NarrowEvaluationPendingResult": { "type": "object", "additionalProperties": false, "required": [ "status", "finality" ], "properties": { "status": { "type": "string", "enum": [ "pending", "under_review" ] }, "finality": { "type": "string", "const": "not_served" } } }, "NarrowEvaluationServedResult": { "type": "object", "additionalProperties": false, "required": [ "status", "finality", "outcomeCode", "settlementAction", "criterionFindings", "determinations", "award" ], "properties": { "status": { "type": "string", "const": "served" }, "finality": { "type": "string", "enum": [ "served", "appealable", "appeal_reserved", "appeal_pending", "final" ] }, "outcomeCode": { "type": "string" }, "settlementAction": { "type": "object", "additionalProperties": false, "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "release_to_claimant", "release_to_respondent", "allocate_by_award", "none" ] } } }, "criterionFindings": { "type": "array", "minItems": 1, "maxItems": 20, "items": { "$ref": "#/components/schemas/NarrowEvaluationCriterionFinding" } }, "determinations": { "type": "object", "additionalProperties": true }, "award": { "$ref": "#/components/schemas/NarrowEvaluationAwardReference" } } }, "NarrowEvaluationResource": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "caseId", "externalCaseId", "externalEvaluationId", "evaluationDigest", "question", "allowedOutcomes", "evidencePolicy", "reviewPolicy", "record", "result" ], "properties": { "schemaVersion": { "type": "string", "const": "narrow-evaluation-resource-v2" }, "caseId": { "type": "string" }, "externalCaseId": { "type": "string" }, "externalEvaluationId": { "type": "string" }, "evaluationDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "question": { "type": "object", "additionalProperties": false, "required": [ "text", "criteria" ], "properties": { "text": { "type": "string" }, "criteria": { "type": "array", "minItems": 1, "maxItems": 20, "items": { "$ref": "#/components/schemas/NarrowEvaluationCriterion" } } } }, "allowedOutcomes": { "type": "array", "items": { "$ref": "#/components/schemas/NarrowEvaluationOutcome" } }, "evidencePolicy": { "$ref": "#/components/schemas/NarrowEvaluationEvidencePolicy" }, "reviewPolicy": { "$ref": "#/components/schemas/NarrowEvaluationReviewPolicy" }, "record": { "$ref": "#/components/schemas/NarrowEvaluationRecord" }, "result": { "oneOf": [ { "$ref": "#/components/schemas/NarrowEvaluationPendingResult" }, { "$ref": "#/components/schemas/NarrowEvaluationServedResult" } ], "discriminator": { "propertyName": "status" } } } }, "NarrowEvaluationAcceptanceInput": { "type": "object", "additionalProperties": false, "required": [ "inviteToken", "principalId", "actorId", "confirmationStatement", "confirmationReference" ], "properties": { "inviteToken": { "type": "string" }, "principalId": { "type": "string" }, "actorId": { "type": "string" }, "confirmationStatement": { "type": "string", "description": "Copy the exact confirmationStatement returned by the respondent handoff; do not reconstruct or rewrite it." }, "confirmationReference": { "type": "string" } } }, "NarrowEvaluationAcceptance": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "caseId", "externalEvaluationId", "evaluationDigest", "accepted", "status", "evaluationPath", "capabilityDelivery" ], "properties": { "schemaVersion": { "type": "string", "const": "narrow-evaluation-acceptance-v2" }, "caseId": { "type": "string" }, "externalEvaluationId": { "type": "string" }, "evaluationDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "accepted": { "type": "boolean", "const": true }, "status": { "type": "string", "const": "awaiting_party_submissions" }, "evaluationPath": { "type": "string" }, "capabilityDelivery": { "type": "string", "const": "show_once_not_replayed" }, "showOnce": { "type": "object", "additionalProperties": false, "required": [ "respondentPartyToken" ], "properties": { "respondentPartyToken": { "type": "string" } } } } }, "PartnerAuthenticityChallengeInput": { "type": "object", "additionalProperties": false, "required": [ "ground" ], "properties": { "ground": { "type": "string", "minLength": 1, "maxLength": 4096, "description": "Plain party text. Sanitizer quarantine causes the request to fail without a write." } } }, "PartnerAuthenticityChallenge": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "caseId", "evidenceId", "challenge", "recordEffect", "resolutionAuthority" ], "properties": { "schemaVersion": { "type": "string", "const": "partner-authenticity-challenge-v2" }, "caseId": { "type": "string" }, "evidenceId": { "type": "string" }, "challenge": { "type": "object", "additionalProperties": false, "required": [ "byParty", "ground", "raisedAt", "status" ], "properties": { "byParty": { "type": "string", "enum": [ "claimant", "respondent" ] }, "ground": { "type": "string" }, "raisedAt": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "raised", "sustained", "overruled" ] }, "resolvedAt": { "type": "string", "format": "date-time" }, "resolvedBy": { "type": "string" } } }, "recordEffect": { "type": "string", "const": "contested_weight_only" }, "resolutionAuthority": { "type": "string", "enum": [ "assigned_reviewer_only", "assigned_tribunal" ], "description": "Current Rules use the assigned AI Tribunal; historical cases retain their pinned assigned-reviewer authority." } } }, "PartnerAuthenticityChallengeList": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "caseId", "evidenceId", "challenges", "recordEffect", "resolutionAuthority" ], "properties": { "schemaVersion": { "type": "string", "const": "partner-authenticity-challenge-list-v2" }, "caseId": { "type": "string" }, "evidenceId": { "type": "string" }, "challenges": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "byParty", "ground", "raisedAt", "status" ], "properties": { "byParty": { "type": "string", "enum": [ "claimant", "respondent" ] }, "ground": { "type": "string" }, "raisedAt": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "raised", "sustained", "overruled" ] }, "resolvedAt": { "type": "string", "format": "date-time" }, "resolvedBy": { "type": "string" } } } }, "recordEffect": { "type": "string", "const": "contested_weight_only" }, "resolutionAuthority": { "type": "string", "enum": [ "assigned_reviewer_only", "assigned_tribunal" ], "description": "Current Rules use the assigned AI Tribunal; historical cases retain their pinned assigned-reviewer authority." } } }, "PartnerAwardArtifactAttestation": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "case", "artifact", "source", "attestationDigest", "signature" ], "properties": { "schemaVersion": { "type": "string", "const": "partner-award-artifact-attestation-v2" }, "case": { "type": "object", "additionalProperties": false, "required": [ "caseId", "externalCaseId" ], "properties": { "caseId": { "type": "string" }, "externalCaseId": { "type": "string" } } }, "artifact": { "type": "object", "additionalProperties": false, "required": [ "artifactId", "schemaVersion", "mediaType", "byteLength", "sha256" ], "properties": { "artifactId": { "type": "string", "pattern": "^pav2_" }, "schemaVersion": { "type": "string", "const": "award-decision-v2" }, "mediaType": { "type": "string", "const": "application/json" }, "byteLength": { "type": "integer", "minimum": 1 }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "source": { "type": "object", "additionalProperties": false, "required": [ "awardHash", "dispositionId", "awardRevision", "artifactSha256", "artifacts" ], "properties": { "awardHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "dispositionId": { "type": "string" }, "awardRevision": { "type": "integer", "minimum": 1 }, "artifactSha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "artifacts": { "type": "array", "description": "Exactly one descriptor for each frozen source kind: pdf, docx, and json.", "minItems": 3, "maxItems": 3, "items": { "type": "object", "additionalProperties": false, "required": [ "artifactId", "kind", "mediaType", "byteLength", "sha256" ], "properties": { "artifactId": { "type": "string" }, "kind": { "type": "string", "enum": [ "pdf", "docx", "json" ] }, "mediaType": { "type": "string" }, "byteLength": { "type": "integer", "minimum": 1 }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } } } } }, "attestationDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "signature": { "type": "object", "additionalProperties": false, "required": [ "signature", "signerAddress", "algorithm", "signedAt", "signedHash" ], "properties": { "signature": { "type": "string" }, "signerAddress": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" }, "algorithm": { "type": "string", "const": "eip191" }, "signedAt": { "type": "string", "format": "date-time" }, "signedHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } } } }, "PartnerCaseRecordBundleManifest": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "recipe", "partnerId", "caseId", "externalCaseId", "caseRevision", "profile", "partySide", "sourceSnapshotHash", "snapshotAt", "rules", "files", "exclusions", "bundleId", "bundleHash" ], "properties": { "schemaVersion": { "type": "string", "const": "case-record-bundle-v2" }, "recipe": { "type": "string", "const": "sha256-canonical-json-v2" }, "partnerId": { "type": "string" }, "caseId": { "type": "string" }, "externalCaseId": { "type": "string" }, "caseRevision": { "type": "integer", "minimum": 1 }, "dispositionId": { "type": "string" }, "awardRevision": { "type": "integer", "minimum": 1 }, "profile": { "type": "string", "const": "party" }, "partySide": { "type": "string", "enum": [ "claimant", "respondent" ] }, "sourceSnapshotHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "snapshotAt": { "type": "string", "format": "date-time" }, "rules": { "type": "object", "additionalProperties": false, "properties": { "version": { "type": "string" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "files": { "type": "array", "minItems": 3, "items": { "type": "object", "additionalProperties": false, "required": [ "path", "mediaType", "byteLength", "sha256", "category" ], "properties": { "path": { "type": "string" }, "mediaType": { "type": "string" }, "byteLength": { "type": "integer", "minimum": 1 }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "sourceSha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "sourceId": { "type": "string" }, "category": { "type": "string" } } } }, "exclusions": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "code", "detail" ], "properties": { "code": { "type": "string" }, "sourceId": { "type": "string" }, "detail": { "type": "string" } } } }, "bundleId": { "type": "string", "pattern": "^crb2_[a-f0-9]{64}$" }, "bundleHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "PartnerCaseRecordBundleAttestation": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "partnerId", "caseId", "externalCaseId", "partySide", "caseRevision", "bundleId", "bundleHash", "rules", "files", "attestationDigest", "signature" ], "properties": { "schemaVersion": { "type": "string", "const": "partner-case-record-bundle-attestation-v2" }, "partnerId": { "type": "string" }, "caseId": { "type": "string" }, "externalCaseId": { "type": "string" }, "partySide": { "type": "string", "enum": [ "claimant", "respondent" ] }, "caseRevision": { "type": "integer", "minimum": 1 }, "bundleId": { "type": "string", "pattern": "^crb2_[a-f0-9]{64}$" }, "bundleHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "rules": { "type": "object", "additionalProperties": false, "properties": { "version": { "type": "string" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "files": { "type": "array", "minItems": 3, "items": { "type": "object", "additionalProperties": false, "required": [ "path", "mediaType", "byteLength", "sha256" ], "properties": { "path": { "type": "string" }, "mediaType": { "type": "string" }, "byteLength": { "type": "integer", "minimum": 0 }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } } }, "attestationDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "signature": { "type": "object", "additionalProperties": false, "required": [ "signature", "signerAddress", "algorithm", "signedAt", "signedHash" ], "properties": { "signature": { "type": "string" }, "signerAddress": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" }, "algorithm": { "type": "string", "const": "eip191" }, "signedAt": { "type": "string", "format": "date-time" }, "signedHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } } } }, "PartnerProceduralMessageInput": { "type": "object", "additionalProperties": false, "required": [ "category", "text" ], "properties": { "category": { "type": "string", "enum": [ "clarification_request", "clarification_response", "evidence_request", "procedural_notice", "settlement_coordination" ] }, "text": { "type": "string", "minLength": 1, "maxLength": 2000, "description": "Plain text, limited to 2,000 UTF-8 bytes. Control characters other than tab and line breaks are rejected." }, "replyToMessageId": { "type": "string", "minLength": 1, "maxLength": 200 }, "evidenceIds": { "type": "array", "maxItems": 8, "uniqueItems": true, "default": [], "description": "References to existing evidence-system objects in this case. No admission or merits-record effect follows.", "items": { "type": "string", "minLength": 1, "maxLength": 200 } } }, "allOf": [ { "if": { "properties": { "category": { "const": "clarification_response" } } }, "then": { "required": [ "replyToMessageId" ] } } ] }, "PartnerProceduralMessage": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "id", "caseId", "partnerId", "senderKind", "senderCredentialPublicId", "category", "text", "evidenceIds", "messageDigest", "recordEffect", "createdAt" ], "properties": { "schemaVersion": { "type": "string", "const": "partner-procedural-message-v2" }, "id": { "type": "string" }, "caseId": { "type": "string" }, "partnerId": { "type": "string" }, "senderKind": { "type": "string", "enum": [ "party", "platform" ] }, "senderSide": { "type": "string", "enum": [ "claimant", "respondent" ] }, "senderCredentialPublicId": { "type": "string", "description": "Public credential identity; the internal persistence identifier is never returned." }, "category": { "type": "string", "enum": [ "clarification_request", "clarification_response", "evidence_request", "procedural_notice", "settlement_coordination" ] }, "text": { "type": "string", "minLength": 1, "maxLength": 2000 }, "replyToMessageId": { "type": "string", "minLength": 1, "maxLength": 200 }, "evidenceIds": { "type": "array", "maxItems": 8, "uniqueItems": true, "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "messageDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "recordEffect": { "type": "string", "const": "none" }, "createdAt": { "type": "string", "format": "date-time" } } }, "PartnerSettlementCorpus": { "type": "object", "additionalProperties": false, "required": [ "currency", "amountMinorUnits", "claimantPrincipalId", "respondentPrincipalId", "expiresAt" ], "properties": { "currency": { "type": "string", "const": "USD" }, "amountMinorUnits": { "type": "string", "pattern": "^(0|[1-9][0-9]{0,77})$" }, "claimantPrincipalId": { "type": "string" }, "respondentPrincipalId": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" } } }, "PartnerSettlementBindingInput": { "type": "object", "additionalProperties": false, "required": [ "evaluationDigest", "externalReference", "adapter", "mode", "allowedActions", "corpus" ], "properties": { "evaluationDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "externalReference": { "type": "string", "minLength": 1, "maxLength": 500 }, "adapter": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,200}$" }, "mode": { "type": "string", "enum": [ "manual_partner", "partner_callback", "platform_adapter" ] }, "allowedActions": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "release_to_claimant", "release_to_respondent", "allocate_by_award", "none" ] } }, "corpus": { "$ref": "#/components/schemas/PartnerSettlementCorpus" } } }, "PartnerSettlementBinding": { "type": "object", "additionalProperties": false, "required": [ "id", "partnerId", "caseId", "evaluationDigest", "externalReference", "adapter", "mode", "allowedActions", "corpus", "authority", "bindingDigest", "status", "createdAt" ], "properties": { "id": { "type": "string" }, "partnerId": { "type": "string" }, "caseId": { "type": "string" }, "evaluationDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "externalReference": { "type": "string", "minLength": 1, "maxLength": 500 }, "adapter": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,200}$" }, "mode": { "type": "string", "enum": [ "manual_partner", "partner_callback", "platform_adapter" ] }, "allowedActions": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string", "enum": [ "release_to_claimant", "release_to_respondent", "allocate_by_award", "none" ] } }, "corpus": { "$ref": "#/components/schemas/PartnerSettlementCorpus" }, "authority": { "$ref": "#/components/schemas/PartnerSettlementBindingAuthority" }, "bindingDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$", "description": "SHA-256 binding the caller-supplied corpus contract and the server-derived immutable authority metadata." }, "status": { "type": "string", "enum": [ "active", "expired", "revoked" ] }, "createdAt": { "type": "string", "format": "date-time" } } }, "PartnerSettlementBindingAuthority": { "type": "object", "additionalProperties": false, "required": [ "actorCredentialPublicId", "actorPrincipalId", "representedPrincipalId", "actorRole", "authorityGrantId", "requiredScope", "authorityAct", "authorizedAt" ], "properties": { "actorCredentialPublicId": { "type": "string" }, "actorPrincipalId": { "type": "string" }, "representedPrincipalId": { "type": "string" }, "actorRole": { "type": "string", "const": "platform_orchestrator" }, "authorityGrantId": { "type": "string" }, "requiredScope": { "type": "string", "const": "settlement:bindings:manage" }, "authorityAct": { "type": "string", "const": "settle_dispute" }, "authorizedAt": { "type": "string", "format": "date-time" } } }, "PartnerSettlementExecutionInput": { "type": "object", "additionalProperties": false, "required": [ "bindingDigest" ], "properties": { "bindingDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "dryRun": { "type": "boolean", "default": false } } }, "PartnerSettlementAllocation": { "type": "object", "additionalProperties": false, "required": [ "recipient", "principalId", "amountMinorUnits" ], "properties": { "recipient": { "type": "string", "enum": [ "claimant", "respondent" ] }, "principalId": { "type": "string" }, "amountMinorUnits": { "type": "string", "pattern": "^(0|[1-9][0-9]{0,77})$" } } }, "PartnerSettlementAttempt": { "type": "object", "additionalProperties": false, "required": [ "id", "partnerId", "caseId", "bindingId", "bindingDigest", "evaluationDigest", "dispositionId", "awardRevision", "awardHash", "outcomeCode", "action", "amountMinorUnits", "allocations", "currency", "dryRun", "status", "createdAt" ], "properties": { "id": { "type": "string" }, "partnerId": { "type": "string" }, "caseId": { "type": "string" }, "bindingId": { "type": "string" }, "operationId": { "type": "string" }, "operationKey": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "bindingDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "evaluationDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "dispositionId": { "type": "string" }, "awardRevision": { "type": "integer", "minimum": 0 }, "awardHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "outcomeCode": { "type": "string" }, "action": { "type": "string", "enum": [ "release_to_claimant", "release_to_respondent", "allocate_by_award", "none" ] }, "amountMinorUnits": { "type": "string", "pattern": "^(0|[1-9][0-9]{0,77})$" }, "allocations": { "type": "array", "maxItems": 2, "items": { "$ref": "#/components/schemas/PartnerSettlementAllocation" } }, "currency": { "type": "string", "const": "USD" }, "dryRun": { "type": "boolean" }, "status": { "type": "string", "enum": [ "validated", "manual_action_required", "callback_required", "completed", "failed", "blocked", "unknown_outcome" ] }, "adapterReceipt": { "type": "object", "additionalProperties": { "type": "string" } }, "failureCode": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } } }, "PartnerSettlementOperation": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "id", "operationKey", "providerIdempotencyKey", "partnerId", "caseId", "bindingId", "bindingDigest", "dispositionId", "awardRevision", "awardHash", "outcomeCode", "action", "amountMinorUnits", "allocations", "currency", "adapter", "externalReference", "status", "createdAt", "updatedAt" ], "properties": { "schemaVersion": { "type": "string", "const": "partner-settlement-operation-v2" }, "id": { "type": "string" }, "operationKey": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "providerIdempotencyKey": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "partnerId": { "type": "string" }, "caseId": { "type": "string" }, "bindingId": { "type": "string" }, "bindingDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "dispositionId": { "type": "string" }, "awardRevision": { "type": "integer", "minimum": 0 }, "awardHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "outcomeCode": { "type": "string" }, "action": { "type": "string", "enum": [ "release_to_claimant", "release_to_respondent", "allocate_by_award", "none" ] }, "amountMinorUnits": { "type": "string", "pattern": "^(0|[1-9][0-9]{0,77})$" }, "allocations": { "type": "array", "maxItems": 2, "items": { "$ref": "#/components/schemas/PartnerSettlementAllocation" } }, "currency": { "type": "string", "const": "USD" }, "adapter": { "type": "string" }, "externalReference": { "type": "string" }, "status": { "type": "string", "enum": [ "prepared", "submitting", "unknown_outcome", "manual_action_required", "callback_required", "completed", "failed", "blocked" ] }, "adapterReceipt": { "type": "object", "additionalProperties": { "type": "string" } }, "failureCode": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "PartnerWebhookEndpointInput": { "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2000 }, "rotateFromEndpointId": { "type": "string" }, "overlapSeconds": { "type": "integer", "minimum": 60, "maximum": 86400 } }, "dependentRequired": { "rotateFromEndpointId": [ "overlapSeconds" ], "overlapSeconds": [ "rotateFromEndpointId" ] } }, "PartnerWebhookDeliveryAttempt": { "type": "object", "additionalProperties": false, "required": [ "attemptNumber", "status", "keyId", "signedAt" ], "properties": { "attemptNumber": { "type": "integer", "minimum": 1 }, "status": { "type": "string", "enum": [ "prepared", "delivered", "retryable_failure", "terminal_failure" ] }, "responseStatus": { "type": "integer" }, "errorCode": { "type": "string" }, "keyId": { "type": "string" }, "signedAt": { "type": "string", "format": "date-time" }, "completedAt": { "type": "string", "format": "date-time" } } }, "PartnerWebhookDelivery": { "type": "object", "additionalProperties": false, "required": [ "eventId", "deliveryId", "sequence", "caseId", "type", "occurredAt", "status", "attempts", "deliveryAttempts" ], "properties": { "caseEvent": { "$ref": "#/components/schemas/CanonicalCaseEvent" }, "eventId": { "type": "string" }, "deliveryId": { "type": "string" }, "sequence": { "type": "integer", "minimum": 1 }, "caseId": { "type": "string" }, "type": { "type": "string" }, "occurredAt": { "type": "string", "format": "date-time" }, "endpointId": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "sending", "delivered", "failed", "suppressed", "dead_letter" ] }, "attempts": { "type": "integer", "minimum": 0 }, "nextAttemptAt": { "type": "string", "format": "date-time" }, "deadLetteredAt": { "type": "string", "format": "date-time" }, "replayOfDeliveryId": { "type": "string" }, "deliveredAt": { "type": "string", "format": "date-time" }, "lastError": { "type": "string" }, "deliveryAttempts": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerWebhookDeliveryAttempt" } } } }, "CaseDraftConfirmation": { "type": "object", "additionalProperties": false, "required": [ "participantId", "draftDigest", "confirmationStatement", "actorId", "principalId", "confirmationMethod", "confirmationReference" ], "properties": { "participantId": { "type": "string" }, "draftDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "confirmationStatement": { "type": "string", "description": "Copy the exact confirmationStatement returned for this participant by GET /api/v2/case-drafts/{draftId}; do not reconstruct or rewrite it." }, "actorId": { "type": "string", "description": "Must equal the participant's immutable agent ID, or the authenticated credential public ID when that participant has no immutable agent." }, "principalId": { "type": "string" }, "confirmationMethod": { "type": "string", "const": "protocol_act" }, "confirmationReference": { "type": "string" }, "acceptance": { "$ref": "#/components/schemas/FilingAcceptanceProof" } } }, "CaseDraftRulesStamp": { "type": "object", "additionalProperties": false, "required": [ "version", "hash" ], "properties": { "version": { "type": "string" }, "hash": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "ResolvedCaseProcedure": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "profile", "answerRequired", "evidenceRounds", "rebuttalRounds", "filingsPerSidePerStage", "recordConfirmationRequired" ], "properties": { "schemaVersion": { "type": "string", "const": "case-procedure-plan-v2" }, "profile": { "type": "string", "enum": [ "standard", "fast", "single_round", "joint_record", "evaluation", "custom_bounded" ] }, "answerRequired": { "type": "boolean" }, "evidenceRounds": { "type": "integer", "minimum": 1, "maximum": 3 }, "rebuttalRounds": { "type": "integer", "minimum": 0, "maximum": 3 }, "filingsPerSidePerStage": { "type": "integer", "minimum": 1, "maximum": 3 }, "recordConfirmationRequired": { "type": "boolean", "const": true } } }, "CaseDraftParticipantResource": { "type": "object", "additionalProperties": false, "required": [ "participantId", "side", "principalId", "authorizationMode" ], "properties": { "participantId": { "type": "string" }, "side": { "type": "string", "enum": [ "claimant", "respondent" ] }, "partnerId": { "type": "string" }, "principalId": { "type": "string" }, "agentId": { "type": "string" }, "authorizationMode": { "type": "string", "enum": [ "partner_credential", "hosted_account" ] } } }, "CaseDraftConfirmationResource": { "type": "object", "additionalProperties": false, "required": [ "participantId", "side", "authorizationMode", "required", "status", "confirmationStatement" ], "properties": { "participantId": { "type": "string" }, "side": { "type": "string", "enum": [ "claimant", "respondent" ] }, "partnerId": { "type": "string" }, "authorizationMode": { "type": "string", "enum": [ "partner_credential", "hosted_account" ] }, "required": { "type": "boolean" }, "status": { "type": "string", "enum": [ "confirmed", "pending", "not_required" ] }, "confirmationStatement": { "type": "string" } } }, "CaseDraftResource": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "draftId", "reservedCaseId", "externalCaseId", "status", "draftDigest", "expiresAt", "rules", "fee", "caseMode", "intakeMode", "confirmationPolicy", "procedure", "participants", "confirmations" ], "properties": { "schemaVersion": { "type": "string", "const": "case-draft-v2" }, "draftId": { "type": "string" }, "reservedCaseId": { "type": "string" }, "externalCaseId": { "type": "string" }, "status": { "type": "string", "enum": [ "awaiting_confirmations", "ready_to_open", "opened" ] }, "draftDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "expiresAt": { "type": "string", "format": "date-time" }, "rules": { "$ref": "#/components/schemas/CaseDraftRulesStamp" }, "fee": { "type": "object", "description": "Exact-money filing-fee projection in USD minor units.", "additionalProperties": true }, "caseMode": { "type": "string", "enum": [ "proceeding", "evaluation" ] }, "intakeMode": { "type": "string", "enum": [ "claimant_initiated", "claimant_proposed", "bilateral_api", "bundled_bilateral" ] }, "confirmationPolicy": { "type": "object", "additionalProperties": false, "required": [ "mode" ], "properties": { "mode": { "type": "string", "enum": [ "initiator_only", "all_participants", "bundled_authorizations" ] } } }, "procedure": { "$ref": "#/components/schemas/ResolvedCaseProcedure" }, "participants": { "type": "array", "items": { "$ref": "#/components/schemas/CaseDraftParticipantResource" } }, "confirmations": { "type": "array", "items": { "$ref": "#/components/schemas/CaseDraftConfirmationResource" } }, "evaluation": { "$ref": "#/components/schemas/CaseDraftEvaluationDefinition" }, "reviewPacket": { "$ref": "#/components/schemas/FilingReviewPacket" } } }, "InitialCaseCapabilities": { "type": "object", "additionalProperties": false, "description": "Sensitive capabilities returned only on the initial successful response and never on idempotency replay.", "properties": { "claimantPartyToken": { "type": "string" }, "respondentInviteToken": { "type": "string" }, "respondentLoginPath": { "type": "string", "description": "Tokenized hosted login path for the invited respondent." } } }, "ConfirmedCaseDraft": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "caseId", "externalCaseId", "status", "rules", "createdAt", "headless", "caseMode", "intakeMode", "confirmationPolicy", "procedure", "participants" ], "properties": { "schemaVersion": { "type": "string", "const": "confirmed-filing-v2" }, "caseId": { "type": "string" }, "externalCaseId": { "type": "string" }, "status": { "type": "string" }, "rules": { "$ref": "#/components/schemas/CaseDraftRulesStamp" }, "createdAt": { "type": "string", "format": "date-time" }, "feeCoverage": { "$ref": "#/components/schemas/SponsorshipFeeCoverage" }, "feeDisposition": { "$ref": "#/components/schemas/PartnerFeeDisposition" }, "feeChallenge": { "$ref": "#/components/schemas/PartnerFeeCheckoutChallenge" }, "headless": { "type": "object", "additionalProperties": false, "required": [ "respondentHandoffPath", "answerPath", "capabilityDelivery" ], "properties": { "respondentHandoffPath": { "type": "string" }, "answerPath": { "type": "string" }, "hostedRespondentPath": { "type": "string" }, "capabilityDelivery": { "type": "string", "const": "show_once_not_replayed" } } }, "caseMode": { "type": "string", "enum": [ "proceeding", "evaluation" ] }, "intakeMode": { "type": "string", "enum": [ "claimant_initiated", "claimant_proposed", "bilateral_api", "bundled_bilateral" ] }, "confirmationPolicy": { "type": "object", "additionalProperties": false, "required": [ "mode" ], "properties": { "mode": { "type": "string", "enum": [ "initiator_only", "all_participants", "bundled_authorizations" ] } } }, "procedure": { "$ref": "#/components/schemas/ResolvedCaseProcedure" }, "participants": { "type": "array", "items": { "$ref": "#/components/schemas/CaseDraftParticipantResource" } }, "evaluation": { "type": "object", "additionalProperties": false, "required": [ "externalEvaluationId", "evaluationDigest", "resourcePath" ], "properties": { "externalEvaluationId": { "type": "string" }, "evaluationDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "resourcePath": { "type": "string" } } }, "showOnce": { "$ref": "#/components/schemas/InitialCaseCapabilities" } } }, "CaseDraftResourceEnvelope": { "type": "object", "additionalProperties": false, "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/CaseDraftResource" }, "requestId": { "type": "string" } } }, "ConfirmedCaseDraftEnvelope": { "type": "object", "additionalProperties": false, "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/ConfirmedCaseDraft" }, "requestId": { "type": "string" } } }, "RespondentHandoff": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "caseId", "answerPath", "consentMessage", "capabilityDelivery" ], "properties": { "schemaVersion": { "type": "string", "const": "respondent-handoff-v2" }, "caseId": { "type": "string" }, "action": { "type": "string", "enum": [ "file_answer", "accept_evaluation" ] }, "actionPath": { "type": "string" }, "answerPath": { "type": "string", "description": "Alias of actionPath for clients using Answer terminology." }, "hostedRespondentPath": { "type": "string", "description": "Untokenized hosted login path for human respondents. Present for Answer handoffs, not evaluation acceptance." }, "consentMessage": { "type": "string", "description": "Action statement associated with the handoff. For a hosted Answer it is the immutable clickthrough statement bound to the public case and opening draft; for a wallet Answer it is the EIP-191 message whose Case line is the public caseId; for evaluation acceptance it equals confirmationStatement." }, "confirmationStatement": { "type": "string", "description": "Exact digest-bound statement required when accepting a claimant-proposed evaluation." }, "evaluationDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "capabilityDelivery": { "type": "string", "const": "show_once_not_replayed" }, "showOnce": { "type": "object", "additionalProperties": false, "required": [ "respondentInviteToken" ], "properties": { "respondentInviteToken": { "type": "string" }, "respondentLoginPath": { "type": "string", "description": "Show-once tokenized hosted login path. Never returned by an idempotency replay." } } } } }, "Problem": { "type": "object", "required": [ "type", "title", "status", "code", "detail", "requestId" ], "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "requestId": { "type": "string" } } }, "ClaimantAcceptanceIdentity": { "type": "object", "additionalProperties": false, "required": [ "email" ], "properties": { "accountId": { "type": "string", "description": "Optional People’s Court account ID allowed to accept. Otherwise the signed-in account must have the normalized, verified claimant email." }, "email": { "type": "string", "format": "email", "description": "Requires a signed-in account with this verified email." }, "walletAddress": { "type": "string", "pattern": "^0x[0-9a-fA-F]{40}$" } } }, "WalletFilingAcceptance": { "type": "object", "additionalProperties": false, "required": [ "method", "termsDigest", "walletAddress", "signature" ], "properties": { "method": { "type": "string", "const": "wallet_signature" }, "termsDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "walletAddress": { "type": "string", "pattern": "^0x[0-9a-fA-F]{40}$" }, "signature": { "type": "string", "pattern": "^0x[0-9a-fA-F]{130}$" } } }, "FilingReviewPacket": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "draftId", "caseId", "draftDigest", "parties", "claimantIdentity", "agentOfRecord", "preparingPartnerId", "claimSummary", "claimStatement", "requestedItems", "amount", "rules", "procedure", "aiDisclosure", "fees", "requiredConfirmations", "scope", "expiresAt", "termsDigest", "acceptanceStatement", "walletMessage" ], "properties": { "schemaVersion": { "type": "string", "const": "filing-review-packet-v1" }, "draftId": { "type": "string" }, "caseId": { "type": "string" }, "draftDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "parties": { "type": "object", "additionalProperties": false, "required": [ "claimant", "respondent" ], "properties": { "claimant": { "type": "object", "additionalProperties": false, "required": [ "principalId", "name" ], "properties": { "principalId": { "type": "string" }, "name": { "type": "string" } } }, "respondent": { "type": "object", "additionalProperties": false, "required": [ "principalId", "name" ], "properties": { "principalId": { "type": "string" }, "name": { "type": "string" } } } } }, "claimantIdentity": { "$ref": "#/components/schemas/ClaimantAcceptanceIdentity" }, "agentOfRecord": { "type": "string" }, "preparingPartnerId": { "type": "string" }, "claimSummary": { "type": "string" }, "claimStatement": { "type": "string" }, "requestedItems": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "kind", "text" ], "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "refund", "release", "split", "other", "monetary", "declaratory", "order" ] }, "text": { "type": "string" }, "amount": { "$ref": "#/components/schemas/FiatMoney" } } } }, "amount": { "$ref": "#/components/schemas/FiatMoney" }, "rules": { "type": "object", "additionalProperties": false, "required": [ "version", "hash" ], "properties": { "version": { "type": "string" }, "hash": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "procedure": { "type": "object", "additionalProperties": false, "required": [ "name", "finalityPath", "configuration" ], "properties": { "name": { "type": "string", "enum": [ "standard", "agent_only" ] }, "finalityPath": { "type": "string", "enum": [ "human_appeal", "agent_finality" ] }, "configuration": { "type": "object", "additionalProperties": true }, "agentFinalityTerms": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Exact registered Rules, behavior and disclosure tuple, including its termsHash." } } }, "aiDisclosure": { "type": "object", "additionalProperties": false, "required": [ "version", "hash" ], "properties": { "version": { "type": "string" }, "hash": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "fees": { "type": "object", "additionalProperties": true }, "requiredConfirmations": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "side", "principalId", "required", "statement" ], "properties": { "side": { "type": "string", "enum": [ "claimant", "respondent" ] }, "principalId": { "type": "string" }, "required": { "type": "boolean" }, "statement": { "type": "string" } } } }, "scope": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" }, "termsDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "acceptanceStatement": { "type": "string" }, "walletMessage": { "type": "string" } } }, "FilingPacketPreparationEnvelope": { "type": "object", "additionalProperties": false, "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "additionalProperties": true, "required": [ "draftId", "draftDigest", "reviewPacket" ], "properties": { "draftId": { "type": "string" }, "draftDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "reviewPacket": { "$ref": "#/components/schemas/FilingReviewPacket" }, "hostedAcceptanceUrl": { "type": "string", "description": "Show-once scoped link, expiring with the packet. The token is a URL fragment and is never included in durable replay." } } }, "requestId": { "type": "string" } } }, "FilingAcceptanceRequiredDetails": { "type": "object", "additionalProperties": false, "required": [ "termsDigest" ], "properties": { "termsDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "reviewPacket": { "$ref": "#/components/schemas/FilingReviewPacket" }, "hostedAcceptanceUrl": { "type": "string" } } }, "FilingAcceptanceRequiredProblem": { "allOf": [ { "$ref": "#/components/schemas/Problem" }, { "type": "object", "properties": { "code": { "type": "string", "const": "acceptance_required" }, "details": { "$ref": "#/components/schemas/FilingAcceptanceRequiredDetails" } } } ] }, "AccountOAuthTerms": { "type": "object", "properties": { "rulesVersion": { "type": "string" }, "rulesHash": { "type": "string" }, "disclosureVersion": { "type": "string" }, "disclosureHash": { "type": "string" } }, "required": [ "rulesVersion", "rulesHash", "disclosureVersion", "disclosureHash" ] }, "AccountStandingBounds": { "type": "object", "properties": { "acts": { "type": "array", "items": { "type": "string", "enum": [ "file_dispute", "answer" ] } }, "maximumAmount": { "type": "object", "properties": { "currency": { "type": "string", "const": "USD" }, "minorUnits": { "type": "string", "pattern": "^[1-9][0-9]{0,14}$" } }, "required": [ "currency", "minorUnits" ] }, "transactionIds": { "type": "array", "items": { "type": "string" } }, "expiresAt": { "type": "string", "format": "date-time" }, "procedure": { "type": "string", "const": "standard" }, "clock": { "type": "string", "const": "ordinary" } }, "required": [ "acts", "maximumAmount", "expiresAt", "procedure", "clock" ] }, "AccountOAuthClient": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string", "enum": [ "personal", "agent", "partner" ] }, "partnerId": { "type": "string" }, "mcpCaseId": { "type": "string" }, "redirectUris": { "type": "array", "items": { "type": "string" } }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "cases:read", "filings:write", "answers:write", "submissions:write", "records:confirm", "records:write", "invitations:write", "messages:write", "remedies:write", "consents:write", "offline_access", "representatives:manage", "procedural:request", "termination:write" ] } }, "createdAt": { "type": "string" }, "revokedAt": { "type": "string" } }, "required": [ "id", "name", "kind", "redirectUris", "scopes", "createdAt" ] }, "AccountAuthorityGrant": { "type": "object", "properties": { "id": { "type": "string" }, "principalId": { "type": "string" }, "clientId": { "type": "string" }, "delegatePartnerId": { "type": "string" }, "scope": { "type": "array", "items": { "type": "string", "enum": [ "cases:read", "filings:write", "answers:write", "submissions:write", "records:confirm", "records:write", "invitations:write", "messages:write", "remedies:write", "consents:write", "offline_access", "representatives:manage", "procedural:request", "termination:write" ] } }, "resource": { "type": "string" }, "terms": { "$ref": "#/components/schemas/AccountOAuthTerms" }, "caseId": { "type": "string" }, "caseBinding": { "type": "object", "properties": { "disputeId": { "type": "string" }, "membershipId": { "type": "string" }, "side": { "type": "string", "enum": [ "claimant", "respondent" ] } }, "required": [ "disputeId", "membershipId", "side" ] }, "standing": { "$ref": "#/components/schemas/AccountStandingBounds" }, "approvedAt": { "type": "string" }, "expiresAt": { "type": "string" }, "revokedAt": { "type": "string" }, "source": { "type": "string", "enum": [ "authorization_code", "hosted_link", "agent_registration" ] }, "status": { "type": "string", "enum": [ "active", "expired", "revoked", "reacceptance_required" ] } }, "required": [ "id", "principalId", "clientId", "scope", "resource", "terms", "approvedAt", "expiresAt", "source" ] }, "AccountAuthorizations": { "type": "object", "properties": { "clients": { "type": "array", "items": { "$ref": "#/components/schemas/AccountOAuthClient" } }, "grants": { "type": "array", "items": { "$ref": "#/components/schemas/AccountAuthorityGrant" } }, "notices": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "grantId": { "type": "string" }, "caseId": { "type": "string" }, "termsDigest": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "grantId", "caseId", "termsDigest", "createdAt" ] } } }, "required": [ "clients", "grants", "notices" ] }, "AccountOAuthTokens": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string", "const": "Bearer" }, "expires_in": { "type": "integer", "maximum": 300 }, "scope": { "type": "string" }, "refresh_token": { "type": "string" } }, "required": [ "access_token", "token_type", "expires_in", "scope" ] }, "AccountOAuthError": { "type": "object", "properties": { "error": { "type": "string" }, "error_description": { "type": "string" } }, "required": [ "error" ] }, "StandingFilingAcceptance": { "type": "object", "properties": { "method": { "type": "string", "const": "standing_grant" }, "grantId": { "type": "string" }, "termsDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "method", "grantId", "termsDigest" ], "additionalProperties": false }, "FilingAcceptanceProof": { "oneOf": [ { "$ref": "#/components/schemas/WalletFilingAcceptance" }, { "$ref": "#/components/schemas/StandingFilingAcceptance" } ] }, "RepresentativeInvitationPreview": { "type": "object", "required": [ "email", "basisOfAuthority" ], "properties": { "email": { "type": "string", "format": "email" }, "basisOfAuthority": { "type": "string", "minLength": 1 }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "view_record", "receive_notices", "file_submissions", "send_procedural_messages", "file_appeal", "answer_appeal", "file_post_award_request", "report_execution" ] } }, "expiresAt": { "type": "string", "format": "date-time" } } }, "RepresentativeChangePreview": { "type": "object", "required": [ "grantId", "action" ], "properties": { "grantId": { "type": "string" }, "action": { "type": "string", "enum": [ "accept", "revoke", "withdraw" ] }, "professionalStatus": { "type": "string", "enum": [ "licensed_lawyer", "not_lawyer" ] }, "licenseJurisdictions": { "type": "array", "items": { "type": "string" } } }, "description": "Partner membership authority permits only own-side revocation. Acceptance and withdrawal require the representative account." }, "ProcessingDefectPreview": { "type": "object", "required": [ "jobId", "derivativeId", "manifestId", "text" ], "properties": { "jobId": { "type": "string" }, "derivativeId": { "type": "string" }, "manifestId": { "type": "string" }, "text": { "type": "string", "minLength": 1, "maxLength": 2000 } } }, "ProceduralRequestPreview": { "type": "object", "required": [ "body", "procedural" ], "properties": { "body": { "type": "string", "minLength": 1, "maxLength": 2000 }, "procedural": { "type": "object", "required": [ "kind", "requestedRelief" ], "properties": { "kind": { "type": "string", "enum": [ "deadline_extension", "filing_correction", "translation", "challenge", "other" ] }, "requestedRelief": { "type": "string", "minLength": 10, "maxLength": 1500 }, "urgency": { "type": "string", "enum": [ "routine", "urgent" ] }, "urgencyBasis": { "type": "string" }, "urgencyNeededBy": { "type": "string", "format": "date-time" }, "requestedEffect": { "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "const": "none" } } }, { "type": "object", "required": [ "type", "deadline", "deadlineAt" ], "properties": { "type": { "const": "extend_deadline" }, "deadline": { "type": "string", "enum": [ "answer", "evidence", "rebuttal", "close" ] }, "deadlineAt": { "type": "string", "format": "date-time" } } }, { "type": "object", "required": [ "type", "submissionId" ], "properties": { "type": { "const": "open_filing_replacement" }, "submissionId": { "type": "string" } } } ] } } } } }, "CanonicalPrincipalKind": { "type": "string", "enum": [ "individual", "organization", "autonomous_agent" ] }, "CanonicalRepresentativeRole": { "type": "string", "enum": [ "claimant_representative", "respondent_representative" ] }, "CanonicalFiling": { "type": "object", "additionalProperties": false, "required": [ "externalCaseId", "transactionId", "policyVersion", "authorityGrantId", "consentArtifactIds", "claimAmount", "parties", "intakeMode", "confirmationPolicy", "claimantAcceptanceIdentity", "procedure" ], "properties": { "caseMode": { "type": "string", "enum": [ "proceeding", "evaluation" ], "default": "proceeding" }, "externalCaseId": { "type": "string" }, "transactionId": { "type": "string" }, "policyVersion": { "type": "string" }, "authorityGrantId": { "type": "string" }, "consentArtifactIds": { "$ref": "#/components/schemas/CaseDraftConsentArtifactIds" }, "claimAmount": { "$ref": "#/components/schemas/FiatMoney" }, "parties": { "type": "object", "additionalProperties": false, "required": [ "claimant", "respondent" ], "properties": { "claimant": { "type": "object", "additionalProperties": false, "required": [ "externalId", "name", "principalKind" ], "properties": { "externalId": { "type": "string" }, "name": { "type": "string" }, "principalKind": { "$ref": "#/components/schemas/CanonicalPrincipalKind" }, "accountId": { "type": "string", "description": "Required for each Agent-only principal; must bind a registered autonomous-agent account." } } }, "respondent": { "type": "object", "additionalProperties": false, "required": [ "externalId", "name", "principalKind" ], "properties": { "externalId": { "type": "string" }, "name": { "type": "string" }, "principalKind": { "$ref": "#/components/schemas/CanonicalPrincipalKind" }, "accountId": { "type": "string", "description": "Required for each Agent-only principal; must bind a registered autonomous-agent account." } } } } }, "summary": { "type": "string" }, "backgroundFacts": { "type": "string" }, "claim": { "$ref": "#/components/schemas/CanonicalComplaintClaim" }, "feeReferralAuthorizationId": { "type": "string", "description": "Neutral agreement-derived fee referral. Mutually exclusive with sponsorshipReferralId." }, "sponsorshipReferralId": { "type": "string", "deprecated": true, "description": "Legacy fixed-$5 sponsorship referral. Mutually exclusive with feeReferralAuthorizationId." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } }, "intakeMode": { "type": "string", "enum": [ "claimant_initiated", "claimant_proposed", "bilateral_api", "bundled_bilateral" ] }, "confirmationPolicy": { "type": "object", "additionalProperties": false, "required": [ "mode" ], "properties": { "mode": { "type": "string", "enum": [ "initiator_only", "all_participants", "bundled_authorizations" ] } } }, "procedure": { "type": "string", "enum": [ "standard", "agent_only" ] }, "evaluation": { "$ref": "#/components/schemas/NarrowEvaluationDefinitionInput" }, "participants": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "object", "additionalProperties": false, "required": [ "role" ], "properties": { "side": { "type": "string", "enum": [ "claimant", "respondent" ] }, "partnerId": { "type": "string", "description": "Required for API-authorized participants. Omit it for the hosted respondent in claimant_initiated mode." }, "agentId": { "type": "string" }, "role": { "$ref": "#/components/schemas/CanonicalRepresentativeRole" } } } }, "claimantAcceptanceIdentity": { "description": "Optional packet identity. When omitted, existing partner consent and hosted respondent behavior apply; no hosted claimant acceptance link is issued. Canonical filings require this identity.", "$ref": "#/components/schemas/ClaimantAcceptanceIdentity" }, "schedule": { "$ref": "#/components/schemas/CaseProcedure" } }, "allOf": [ { "not": { "required": [ "feeReferralAuthorizationId", "sponsorshipReferralId" ] } }, { "oneOf": [ { "title": "Claimant initiates and respondent may consent later", "properties": { "intakeMode": { "type": "string", "const": "claimant_initiated" } }, "oneOf": [ { "title": "Hosted respondent consents after opening", "properties": { "consentArtifactIds": { "$ref": "#/components/schemas/ClaimantOnlyConsentArtifactIds" }, "participants": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "object", "additionalProperties": false, "required": [ "role" ], "properties": { "side": { "type": "string", "enum": [ "claimant", "respondent" ] }, "partnerId": { "type": "string", "description": "Required for API-authorized participants. Omit it for the hosted respondent in claimant_initiated mode." }, "agentId": { "type": "string" }, "role": { "$ref": "#/components/schemas/CanonicalRepresentativeRole" } } } } } }, { "title": "Respondent consent was registered in advance", "properties": { "consentArtifactIds": { "$ref": "#/components/schemas/ConsentArtifactIds" } } } ] }, { "title": "Bilaterally authorized or claimant-proposed case", "properties": { "intakeMode": { "type": "string", "enum": [ "claimant_proposed", "bilateral_api", "bundled_bilateral" ] }, "consentArtifactIds": { "$ref": "#/components/schemas/ConsentArtifactIds" } } } ] }, { "if": { "properties": { "procedure": { "const": "agent_only" } } }, "then": { "properties": { "parties": { "properties": { "claimant": { "required": [ "accountId" ], "properties": { "principalKind": { "const": "autonomous_agent" } } }, "respondent": { "required": [ "accountId" ], "properties": { "principalKind": { "const": "autonomous_agent" } } } } } } }, "else": { "properties": { "parties": { "properties": { "claimant": { "not": { "required": [ "accountId" ] } }, "respondent": { "not": { "required": [ "accountId" ] } } } } } } } ], "oneOf": [ { "title": "Proceeding case", "required": [ "summary", "claim" ], "properties": { "caseMode": { "type": "string", "const": "proceeding" } } }, { "title": "Narrow evaluation case", "required": [ "caseMode", "evaluation" ], "properties": { "caseMode": { "type": "string", "const": "evaluation" } } } ], "description": "Canonical intake vocabulary. Agent-only requires two registered autonomous-agent account IDs and each account’s exact case-specific OAuth acceptance before opening. External principal IDs remain delegation references, never account credentials. Internal names are rejected. Historical v2 drafts remain readable without rewriting." }, "CanonicalCaseEvent": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "id", "cursor", "type", "occurredAt" ], "properties": { "schemaVersion": { "type": "string", "const": "case-event-v1" }, "id": { "type": "string" }, "cursor": { "type": "string", "description": "Opaque audit ID identifying a monotonically advancing committed per-case position. Never interpret or compare cursor text." }, "type": { "type": "string" }, "occurredAt": { "type": "string", "format": "date-time" } } }, "CanonicalCaseEventPage": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "caseId", "events", "nextCursor", "hasMore" ], "properties": { "schemaVersion": { "type": "string", "const": "case-event-page-v1" }, "caseId": { "type": "string" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/CanonicalCaseEvent" } }, "nextCursor": { "type": [ "string", "null" ] }, "hasMore": { "type": "boolean" } } }, "CanonicalPreparedFiling": { "type": "object", "additionalProperties": true, "required": [ "schemaVersion", "draftId", "draftDigest", "procedure", "schedule", "parties" ], "properties": { "schemaVersion": { "type": "string", "const": "filing-v1" }, "draftId": { "type": "string" }, "draftDigest": { "type": "string" }, "procedure": { "type": "string", "enum": [ "standard", "agent_only" ] }, "schedule": { "type": "object", "additionalProperties": false, "required": [ "profile" ], "properties": { "profile": { "type": "string", "enum": [ "standard", "fast", "single_round", "joint_record", "evaluation", "custom_bounded" ] }, "answerRequired": { "type": "boolean" }, "evidenceRounds": { "type": "integer", "minimum": 1, "maximum": 3 }, "rebuttalRounds": { "type": "integer", "minimum": 0, "maximum": 3 }, "filingsPerSidePerStage": { "type": "integer", "minimum": 1, "maximum": 3 }, "recordConfirmationRequired": { "type": "boolean", "const": true }, "schemaVersion": { "type": "string", "const": "case-procedure-plan-v2" } } }, "parties": { "type": "object", "additionalProperties": false, "required": [ "claimant", "respondent" ], "properties": { "claimant": { "type": "object", "additionalProperties": false, "required": [ "externalId", "name", "principalKind" ], "properties": { "externalId": { "type": "string" }, "name": { "type": "string" }, "principalKind": { "$ref": "#/components/schemas/CanonicalPrincipalKind" } } }, "respondent": { "type": "object", "additionalProperties": false, "required": [ "externalId", "name", "principalKind" ], "properties": { "externalId": { "type": "string" }, "name": { "type": "string" }, "principalKind": { "$ref": "#/components/schemas/CanonicalPrincipalKind" } } } } }, "status": { "type": "string", "description": "Agent-only preparation reports awaiting_agent_acceptances until both bound accounts accept." }, "agentConsentUrl": { "type": "string", "description": "Agent-only: each bound account uses its OAuth token to read and accept its exact statement here." }, "hostedAcceptanceUrl": { "type": "string", "description": "Standard procedure: show-once claimant acceptance link, omitted on replay." }, "reviewPacket": { "$ref": "#/components/schemas/FilingReviewPacket" } } }, "CanonicalCurrentRules": { "type": "object", "properties": { "rulesVersion": { "type": "string" }, "rulesHash": { "type": "string" }, "rulesetId": { "type": "string" }, "dynamicRulesetId": { "type": "string" }, "apiCompatibilityVersion": { "type": "string" }, "application": { "const": "prospective_and_case_pinned", "type": "string" } }, "required": [ "rulesVersion", "rulesHash", "rulesetId", "dynamicRulesetId", "apiCompatibilityVersion", "application" ] }, "CanonicalSubmission": { "type": "object", "properties": { "id": { "type": "string" }, "disputeId": { "type": "string" }, "party": { "type": "string", "enum": [ "claimant", "respondent" ] }, "brief": { "type": "string" }, "evidenceIds": { "type": "array", "items": { "type": "string" } }, "submittedAt": { "type": "string" }, "phase": { "type": "string" }, "sealedAt": { "type": "string" }, "revealedAt": { "type": "string" }, "contentHash": { "type": "string" }, "supersededAt": { "type": "string" }, "supersededBy": { "type": "string" } }, "required": [ "id", "party", "brief", "evidenceIds", "submittedAt" ] }, "CanonicalEvidence": { "type": "object", "properties": { "id": { "type": "string" }, "disputeId": { "type": "string" }, "party": { "type": "string", "enum": [ "claimant", "respondent" ] }, "kind": { "type": "string" }, "filename": { "type": "string" }, "mimeType": { "type": "string" }, "contentHash": { "type": "string" }, "createdAt": { "type": "string" }, "revealedAt": { "type": "string" }, "extractedText": { "type": "string" } }, "required": [ "id", "party" ] }, "CanonicalSubmissionResult": { "type": "object", "properties": { "schemaVersion": { "type": "string" }, "submission": { "$ref": "#/components/schemas/CanonicalSubmission" }, "evidence": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "phase": { "type": "string" }, "reliabilityTier": { "type": "string" }, "contentHash": { "type": "string" }, "extractionError": { "type": "string" }, "neutralizedCount": { "type": "integer" } }, "required": [ "id", "label", "phase", "reliabilityTier", "contentHash", "neutralizedCount" ] } }, "security": { "type": "object", "properties": { "neutralizedCount": { "type": "integer" }, "quarantinedExhibits": { "type": "integer" }, "attributableTo": { "type": "string", "enum": [ "claimant", "respondent" ] } }, "required": [ "neutralizedCount", "quarantinedExhibits" ] }, "sealed": { "type": "boolean" }, "phase": { "type": "string" }, "deadlines": { "type": "object", "properties": { "answer": { "type": "string" }, "evidence": { "type": "string" }, "rebuttal": { "type": "string" } } }, "evidenceCandidateAdoptions": { "type": "array", "items": { "type": "object", "properties": { "exportRecordId": { "type": "string" }, "artifactRef": { "type": "string" }, "evidenceObjectId": { "type": "string" }, "sourceSha256": { "type": "string" } }, "required": [ "exportRecordId", "artifactRef", "evidenceObjectId", "sourceSha256" ] } } }, "required": [ "submission" ] }, "CanonicalSubmissionList": { "type": "object", "properties": { "submissions": { "type": "array", "items": { "$ref": "#/components/schemas/CanonicalSubmission" } }, "evidence": { "type": "array", "items": { "$ref": "#/components/schemas/CanonicalEvidence" } }, "submissionHistory": { "type": "array", "items": { "$ref": "#/components/schemas/CanonicalSubmission" } }, "evidenceHistory": { "type": "array", "items": { "$ref": "#/components/schemas/CanonicalEvidence" } }, "phase": { "type": "string" }, "deadlines": { "type": "object", "properties": { "answer": { "type": "string" }, "evidence": { "type": "string" }, "rebuttal": { "type": "string" } } }, "operatorAccess": { "type": "string" } }, "required": [ "submissions", "evidence", "submissionHistory", "evidenceHistory" ] }, "CanonicalProcessingRecord": { "type": "object", "properties": { "evidenceId": { "type": "string" }, "sourceId": { "type": "string" }, "filingParty": { "type": "string", "enum": [ "claimant", "respondent" ] }, "filename": { "type": "string" }, "status": { "type": "string" }, "jobId": { "type": "string" }, "processingContractId": { "type": "string" }, "sanitizedDerivativeId": { "type": "string" }, "manifestId": { "type": "string" }, "sanitizedText": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "classification": { "type": "string" } }, "required": [ "code", "classification" ] } }, "omissions": { "type": "array", "items": { "type": "object", "properties": { "expectedUnitId": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "expectedUnitId", "reason" ] } }, "defectStatus": { "type": "string" } }, "required": [ "evidenceId", "sourceId", "filingParty", "filename", "status", "jobId", "processingContractId", "sanitizedDerivativeId", "manifestId", "sanitizedText", "warnings", "omissions", "defectStatus" ] }, "CanonicalProcessingDefectResult": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "const": "open" } }, "required": [ "id", "status" ] }, "CanonicalRepresentative": { "type": "object", "properties": { "id": { "type": "string" }, "party": { "type": "string", "enum": [ "claimant", "respondent" ] }, "representativeEmail": { "type": "string" }, "basisOfAuthority": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "createdAt": { "type": "string" }, "acceptedAt": { "type": "string" }, "revokedAt": { "type": "string" }, "expiresAt": { "type": "string" } }, "required": [ "id", "party", "representativeEmail", "basisOfAuthority", "scopes", "status", "createdAt" ] }, "CanonicalRepresentativeList": { "type": "object", "properties": { "grants": { "type": "array", "items": { "$ref": "#/components/schemas/CanonicalRepresentative" } } }, "required": [ "grants" ] }, "CanonicalRepresentativeResult": { "type": "object", "properties": { "grant": { "$ref": "#/components/schemas/CanonicalRepresentative" }, "invitationEmail": { "type": "string", "enum": [ "sent", "not_configured", "failed", "not_repeated" ] } }, "required": [ "grant" ] }, "CanonicalHostedMessage": { "type": "object", "properties": { "id": { "type": "string" }, "sender": { "type": "object", "properties": { "label": { "type": "string" }, "role": { "type": "string" }, "side": { "type": "string", "enum": [ "claimant", "respondent" ] }, "onBehalfOfParty": { "type": "string", "enum": [ "claimant", "respondent" ] }, "representative": { "type": "object", "properties": { "displayName": { "type": "string" } }, "required": [ "displayName" ] } }, "required": [ "label", "role" ] }, "body": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "sender", "body", "createdAt" ] }, "CanonicalHostedThread": { "type": "object", "properties": { "id": { "type": "string" }, "category": { "type": "string" }, "visibility": { "type": "string" }, "status": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "closedAt": { "type": "string" }, "canReply": { "type": "boolean" }, "proceduralRequest": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "requestedRelief": { "type": "string" }, "status": { "type": "string" }, "responseDueAt": { "type": "string" }, "canRule": { "type": "boolean" } } }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/CanonicalHostedMessage" } } }, "required": [ "id", "category", "visibility", "status", "createdAt", "updatedAt", "canReply", "messages" ] }, "CanonicalHostedThreadList": { "type": "object", "properties": { "threads": { "type": "array", "items": { "$ref": "#/components/schemas/CanonicalHostedThread" } } }, "required": [ "threads" ] }, "CanonicalHostedThreadResult": { "type": "object", "properties": { "thread": { "$ref": "#/components/schemas/CanonicalHostedThread" } }, "required": [ "thread" ] }, "CanonicalProceduralRequestList": { "type": "object", "properties": { "requests": { "type": "array", "items": { "$ref": "#/components/schemas/CanonicalHostedThread" } } }, "required": [ "requests" ] }, "CanonicalPartnerMessageList": { "type": "object", "properties": { "messages": { "type": "array", "items": { "$ref": "#/components/schemas/PartnerProceduralMessage" } }, "recordEffect": { "type": "string", "const": "none" } }, "required": [ "messages", "recordEffect" ] }, "CanonicalAppeal": { "type": "object", "properties": { "id": { "type": "string" }, "disputeId": { "type": "string" }, "filedBy": { "type": "string", "enum": [ "claimant", "respondent" ] }, "filedAt": { "type": "string" }, "sourceDispositionId": { "type": "string" }, "sourceAwardHash": { "type": "string" }, "sourceAwardRevision": { "type": "integer" }, "sourceRecordHash": { "type": "string" }, "feeUsd": { "type": "number" }, "feeRecordId": { "type": "string" }, "feeStatus": { "type": "string", "enum": [ "payable", "confirmed" ] }, "openingBrief": { "type": "object", "properties": { "notice": { "type": "string" }, "claimedErrors": { "type": "array", "items": { "type": "string" } }, "outcomeEffect": { "type": "string" }, "filedAt": { "type": "string" } } }, "answerBrief": { "type": "object", "properties": { "response": { "type": "string" }, "crossErrors": { "type": "array", "items": { "type": "string" } }, "requestedDisposition": { "type": "string" }, "filedAt": { "type": "string" } } }, "answerDueAt": { "type": "string" }, "briefingClosedAt": { "type": "string" }, "briefingCloseReason": { "type": "string" }, "paymentReservationExpiresAt": { "type": "string" }, "docketedAt": { "type": "string" }, "docketNoticeServedAt": { "type": "string" }, "reasonedDisposition": { "type": "object", "properties": { "text": { "type": "string" }, "by": { "type": "string" }, "at": { "type": "string" } } }, "decidedAt": { "type": "string" }, "outcome": { "type": "string" } }, "required": [ "id", "filedBy", "filedAt", "sourceDispositionId", "sourceAwardHash", "sourceAwardRevision", "sourceRecordHash", "feeUsd", "feeStatus" ] }, "CanonicalAppealFeeQuote": { "type": "object", "properties": { "amountUsd": { "type": "number" }, "amountDisplay": { "type": "string" }, "explanation": { "type": "string" }, "waived": { "type": "boolean" } }, "required": [ "amountUsd", "amountDisplay", "explanation", "waived" ] }, "CanonicalAppealFeeChallenge": { "type": "object", "properties": { "method": { "type": "string", "const": "fiat_card" }, "feeRecordId": { "type": "string" }, "amountUsd": { "type": "number" }, "deadlineAt": { "type": "string" }, "checkoutEndpoint": { "type": "string" } }, "required": [ "method", "feeRecordId", "amountUsd", "checkoutEndpoint" ] }, "CanonicalAppealRead": { "type": "object", "properties": { "appeal": { "anyOf": [ { "$ref": "#/components/schemas/CanonicalAppeal" }, { "type": "null" } ] }, "quote": { "$ref": "#/components/schemas/CanonicalAppealFeeQuote" }, "feeChallenge": { "$ref": "#/components/schemas/CanonicalAppealFeeChallenge" } }, "required": [ "appeal", "quote" ] }, "CanonicalAppealResult": { "type": "object", "properties": { "appeal": { "$ref": "#/components/schemas/CanonicalAppeal" }, "status": { "type": "string" }, "feeChallenge": { "$ref": "#/components/schemas/CanonicalAppealFeeChallenge" } }, "required": [ "appeal" ] }, "CanonicalAppealFee": { "type": "object", "properties": { "quote": { "$ref": "#/components/schemas/CanonicalAppealFeeQuote" }, "feeChallenge": { "$ref": "#/components/schemas/CanonicalAppealFeeChallenge" }, "feeStatus": { "anyOf": [ { "type": "string", "enum": [ "payable", "confirmed" ] }, { "type": "null" } ] } }, "required": [ "quote", "feeStatus" ] }, "CanonicalPostAwardRequest": { "type": "object", "properties": { "id": { "type": "string" }, "disputeId": { "type": "string" }, "sourceDispositionId": { "type": "string" }, "sourceAwardHash": { "type": "string" }, "sourceAwardRevision": { "type": "integer" }, "kind": { "type": "string", "enum": [ "correction", "additional_award" ] }, "filedBy": { "type": "string", "enum": [ "claimant", "respondent" ] }, "request": { "type": "string" }, "pleadedReliefIndex": { "type": "integer" }, "filedAt": { "type": "string" }, "responseDueAt": { "type": "string" }, "response": { "type": "object", "properties": { "by": { "type": "string", "enum": [ "claimant", "respondent" ] }, "text": { "type": "string" }, "filedAt": { "type": "string" } }, "required": [ "by", "text", "filedAt" ] }, "status": { "type": "string", "enum": [ "pending", "granted", "denied" ] }, "decidedAt": { "type": "string" }, "decisionReasons": { "type": "string" } }, "required": [ "id", "kind", "filedBy", "request", "filedAt", "responseDueAt", "status" ] }, "CanonicalPostAwardResult": { "type": "object", "properties": { "request": { "$ref": "#/components/schemas/CanonicalPostAwardRequest" } }, "required": [ "request" ] }, "CanonicalPostAwardList": { "type": "object", "properties": { "requests": { "type": "array", "items": { "$ref": "#/components/schemas/CanonicalPostAwardRequest" } } }, "required": [ "requests" ] }, "CanonicalAnswerResult": { "type": "object", "properties": { "schemaVersion": { "type": "string" }, "caseId": { "type": "string" }, "accepted": { "type": "boolean" }, "capabilityDelivery": { "type": "string" }, "status": { "type": "string" }, "phase": { "type": "string" }, "deadlines": { "type": "object", "properties": { "answer": { "type": "string" }, "evidence": { "type": "string" }, "rebuttal": { "type": "string" } } }, "walletVerified": { "type": "boolean" }, "authorization": { "type": "string" }, "showOnce": { "type": "object", "properties": { "respondentPartyToken": { "type": "string" } } }, "respondentToken": { "type": "string", "description": "Show-once hosted respondent capability; never log it." }, "trackNote": { "type": "string" }, "ran": { "const": false }, "answerReference": { "type": "object", "properties": { "caseId": { "type": "string" }, "submissionId": { "type": "string" }, "membershipId": { "type": "string" }, "revision": { "type": "integer" }, "followUpEventId": { "type": "string" } } } }, "anyOf": [ { "required": [ "status" ] }, { "required": [ "schemaVersion", "caseId", "accepted", "capabilityDelivery" ] } ] }, "CanonicalWebhookEndpoint": { "type": "object", "properties": { "id": { "type": "string" }, "partnerId": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "retiring", "disabled" ] }, "signatureVersion": { "type": "string", "const": "pc-webhook-ed25519-v1" }, "replacesEndpointId": { "type": "string" }, "overlapUntil": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "partnerId", "url", "status", "signatureVersion", "createdAt", "updatedAt" ] }, "CanonicalWebhookEndpointResult": { "type": "object", "properties": { "endpoint": { "$ref": "#/components/schemas/CanonicalWebhookEndpoint" }, "rotation": { "type": "object", "properties": { "mode": { "type": "string" }, "overlapUntil": { "type": "string" } } } }, "required": [ "endpoint" ] }, "CanonicalWebhookEndpointList": { "type": "object", "properties": { "schemaVersion": { "type": "string", "const": "partner-webhook-endpoints-v2" }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/CanonicalWebhookEndpoint" } } }, "required": [ "schemaVersion", "endpoints" ] }, "CanonicalCreateOrRotateWebhookEndpointResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CanonicalWebhookEndpointResult" }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/partner-api/v2/webhook-endpoints.ts" }, "CanonicalListWebhookEndpointsResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CanonicalWebhookEndpointList" }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/partner-api/v2/webhook-endpoints.ts" }, "CanonicalGetWebhookEndpointResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CanonicalWebhookEndpointResult" }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/partner-api/v2/webhook-endpoints.ts" }, "CanonicalUpdateWebhookEndpointResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CanonicalWebhookEndpointResult" }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/partner-api/v2/webhook-endpoints.ts" }, "CanonicalDeleteWebhookEndpointResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CanonicalWebhookEndpointResult" }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/partner-api/v2/webhook-endpoints.ts" }, "CanonicalFileSubmissionPreviewResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CanonicalSubmissionResult" }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/submissions/partner-operation.ts" }, "CanonicalListSubmissionsPreviewResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CanonicalSubmissionList" }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/submissions/operations.ts" }, "CanonicalGetEvidenceProcessingPreviewResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CanonicalProcessingRecord" } }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/evidence/durability/review.ts" }, "CanonicalReportProcessingDefectPreviewResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CanonicalProcessingDefectResult" }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/proceeding/evidence-processing.ts" }, "CanonicalFileAppealPreviewResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CanonicalAppealResult" }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/api/canonical-remedies.ts" }, "CanonicalGetAppealsPreviewResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CanonicalAppealRead" }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/proceeding/remedy-operations.ts" }, "CanonicalAnswerAppealPreviewResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CanonicalAppealResult" }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/api/canonical-remedies.ts" }, "CanonicalGetAppealFeePreviewResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CanonicalAppealFee" }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/proceeding/remedy-operations.ts" }, "CanonicalFilePostAwardRequestPreviewResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CanonicalPostAwardResult" }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/api/canonical-remedies.ts" }, "CanonicalListPostAwardRequestsPreviewResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CanonicalPostAwardList" }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/proceeding/remedy-operations.ts" }, "CanonicalFileAnswerPreviewResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CanonicalAnswerResult" }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/api/canonical-routes.ts" }, "CanonicalListAccountCaseMessagesResponse": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#/components/schemas/CanonicalHostedThreadList" }, { "$ref": "#/components/schemas/CanonicalPartnerMessageList" } ] }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/proceeding/messages.ts" }, "CanonicalPostAccountCaseMessageResponse": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#/components/schemas/CanonicalHostedThreadResult" }, { "$ref": "#/components/schemas/PartnerProceduralMessage" } ] }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/proceeding/messages.ts" }, "CanonicalGetCurrentRulesCanonicalResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CanonicalCurrentRules" }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "app/api/v2/rules/current/route.ts" }, "CanonicalAmendSubmissionPreviewResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CanonicalSubmissionResult" }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/submissions/operations.ts" }, "CanonicalFileReplacementPreviewResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CanonicalSubmissionResult" }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/submissions/operations.ts" }, "CanonicalListRepresentativesPreviewResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CanonicalRepresentativeList" }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/proceeding/representatives.ts" }, "CanonicalInviteRepresentativePreviewResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CanonicalRepresentativeResult" }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/proceeding/representatives.ts" }, "CanonicalUpdateRepresentativePreviewResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CanonicalRepresentativeResult" }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/proceeding/representatives.ts" }, "CanonicalListProceduralRequestsPreviewResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CanonicalProceduralRequestList" }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/proceeding/messages.ts" }, "CanonicalFileProceduralRequestPreviewResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CanonicalHostedThreadResult" }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/proceeding/hosted-messages.ts" }, "CanonicalRequestTerminationPreviewResponse": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": false, "required": [ "caseId", "caseStatus", "revision", "termination" ], "properties": { "caseId": { "type": "string" }, "caseStatus": { "type": "string" }, "revision": { "type": "integer", "minimum": 0 }, "termination": { "$ref": "#/components/schemas/CanonicalTermination" }, "deadlinesContinue": { "type": "boolean" } } }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/proceeding/termination-case.ts" }, "CanonicalConfirmTerminationPreviewResponse": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": false, "required": [ "caseId", "caseStatus", "revision", "termination" ], "properties": { "caseId": { "type": "string" }, "caseStatus": { "type": "string" }, "revision": { "type": "integer", "minimum": 0 }, "termination": { "$ref": "#/components/schemas/CanonicalTermination" }, "deadlinesContinue": { "type": "boolean" } } }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/proceeding/termination-case.ts" }, "CanonicalWithdrawClaimPreviewResponse": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": false, "required": [ "caseId", "caseStatus", "revision", "termination" ], "properties": { "caseId": { "type": "string" }, "caseStatus": { "type": "string" }, "revision": { "type": "integer", "minimum": 0 }, "termination": { "$ref": "#/components/schemas/CanonicalTermination" }, "deadlinesContinue": { "type": "boolean" } } }, "requestId": { "type": "string" } }, "required": [ "data", "requestId" ], "x-code-source": "lib/proceeding/termination-case.ts" }, "CanonicalTermination": { "type": "object", "additionalProperties": false, "required": [ "id", "kind", "status", "initiatedBySide", "initiatedAt", "confirmations", "fundsEffect" ], "properties": { "schemaVersion": { "type": "string", "const": "pre-award-termination-v1" }, "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "claimant_withdrawal", "party_agreement" ] }, "status": { "type": "string", "enum": [ "pending", "completed", "cancelled", "superseded" ] }, "initiatedBySide": { "type": "string", "enum": [ "claimant", "respondent" ] }, "initiatedAt": { "type": "string", "format": "date-time" }, "confirmations": { "type": "array", "maxItems": 2, "items": { "type": "object", "additionalProperties": false, "required": [ "side", "confirmedAt" ], "properties": { "side": { "type": "string", "enum": [ "claimant", "respondent" ] }, "confirmedAt": { "type": "string", "format": "date-time" } } } }, "completedAt": { "type": "string", "format": "date-time" }, "cancelledAt": { "type": "string", "format": "date-time" }, "fundsEffect": { "type": "string", "const": "none" }, "adoptsRulesVersion": { "type": "string" }, "adoptsRulesHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "x-code-source": "lib/proceeding/termination-case.ts" }, "CanonicalPartyRestatementRevision": { "type": "object", "properties": { "text": { "type": "string" }, "generatedAt": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "confirmed", "corrected", "lapsed" ] }, "respondedAt": { "type": "string" }, "correction": { "type": "string" }, "revision": { "type": "integer" }, "sourceSubmissionIds": { "type": "array", "items": { "type": "string" } }, "sourceContentHashes": { "type": "array", "items": { "type": "string" } }, "sourceFingerprint": { "type": "string" }, "confirmationDueAt": { "type": "string" }, "rejectedCorrections": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "reason": { "type": "string" }, "at": { "type": "string" } } } }, "requestInventory": { "type": "object", "properties": { "version": { "type": "string" }, "party": { "type": "string", "enum": [ "claimant", "respondent" ] }, "sourceFingerprint": { "type": "string" }, "restatementRevision": { "type": "integer" }, "parents": { "type": "array", "items": { "type": "object", "properties": { "parentId": { "type": "string" }, "claimId": { "type": "string" }, "title": { "type": "string" }, "statement": { "type": "string" }, "kind": { "type": "string" }, "currency": { "type": "string" } } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string" }, "parentId": { "type": "string" }, "parentClaimId": { "type": "string" }, "kind": { "type": "string" }, "fixedText": { "type": "string" }, "requestedAmount": { "type": "number" }, "currency": { "type": "string" }, "canonicalDeclaration": { "type": "string" }, "canonicalOrder": { "type": "string" }, "severableScopes": { "type": "array", "items": { "type": "object", "properties": { "scopeId": { "type": "string" }, "fixedText": { "type": "string" }, "source": { "type": "object", "properties": { "sourceId": { "type": "string" }, "sourceContentHash": { "type": "string" }, "firstLine": { "type": "integer" }, "lastLine": { "type": "integer" }, "exactText": { "type": "string" } } } } } }, "source": { "type": "object", "properties": { "sourceId": { "type": "string" }, "sourceContentHash": { "type": "string" }, "firstLine": { "type": "integer" }, "lastLine": { "type": "integer" }, "exactText": { "type": "string" } } }, "residual": { "type": "boolean" } } } }, "originalParentCoverage": { "type": "array", "items": { "type": "string" } }, "displayText": { "type": "string" }, "displayDigest": { "type": "string" }, "inventoryHash": { "type": "string" }, "status": { "type": "string" }, "respondedAt": { "type": "string" } } } } }, "CanonicalPartyRestatement": { "type": "object", "properties": { "text": { "type": "string" }, "generatedAt": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "confirmed", "corrected", "lapsed" ] }, "respondedAt": { "type": "string" }, "correction": { "type": "string" }, "revision": { "type": "integer" }, "sourceSubmissionIds": { "type": "array", "items": { "type": "string" } }, "sourceContentHashes": { "type": "array", "items": { "type": "string" } }, "sourceFingerprint": { "type": "string" }, "confirmationDueAt": { "type": "string" }, "rejectedCorrections": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "reason": { "type": "string" }, "at": { "type": "string" } } } }, "requestInventory": { "type": "object", "properties": { "version": { "type": "string" }, "party": { "type": "string", "enum": [ "claimant", "respondent" ] }, "sourceFingerprint": { "type": "string" }, "restatementRevision": { "type": "integer" }, "parents": { "type": "array", "items": { "type": "object", "properties": { "parentId": { "type": "string" }, "claimId": { "type": "string" }, "title": { "type": "string" }, "statement": { "type": "string" }, "kind": { "type": "string" }, "currency": { "type": "string" } } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string" }, "parentId": { "type": "string" }, "parentClaimId": { "type": "string" }, "kind": { "type": "string" }, "fixedText": { "type": "string" }, "requestedAmount": { "type": "number" }, "currency": { "type": "string" }, "canonicalDeclaration": { "type": "string" }, "canonicalOrder": { "type": "string" }, "severableScopes": { "type": "array", "items": { "type": "object", "properties": { "scopeId": { "type": "string" }, "fixedText": { "type": "string" }, "source": { "type": "object", "properties": { "sourceId": { "type": "string" }, "sourceContentHash": { "type": "string" }, "firstLine": { "type": "integer" }, "lastLine": { "type": "integer" }, "exactText": { "type": "string" } } } } } }, "source": { "type": "object", "properties": { "sourceId": { "type": "string" }, "sourceContentHash": { "type": "string" }, "firstLine": { "type": "integer" }, "lastLine": { "type": "integer" }, "exactText": { "type": "string" } } }, "residual": { "type": "boolean" } } } }, "originalParentCoverage": { "type": "array", "items": { "type": "string" } }, "displayText": { "type": "string" }, "displayDigest": { "type": "string" }, "inventoryHash": { "type": "string" }, "status": { "type": "string" }, "respondedAt": { "type": "string" } } }, "priorRevisions": { "type": "array", "items": { "$ref": "#/components/schemas/CanonicalPartyRestatementRevision" } } }, "x-code-source": "lib/types.ts" }, "CanonicalGetServedAwardCanonicalResponse": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "properties": { "caseId": { "type": "string" }, "externalCaseId": { "type": "string" }, "award": { "type": "object", "properties": { "id": { "type": "string" }, "awardHash": { "type": "string" }, "awardHashVersion": { "type": "integer" }, "awardRevision": { "type": "integer" }, "rulesVersion": { "type": "string" }, "dispositionLabel": { "type": "string" }, "posture": { "type": "string" }, "releasedToParties": { "type": "boolean" }, "releasedAt": { "type": "string" }, "companionArtifacts": { "type": "array", "items": { "type": "object", "properties": { "artifactId": { "type": "string" }, "kind": { "type": "string" }, "schemaVersion": { "type": "string" }, "mediaType": { "type": "string" }, "byteLength": { "type": "integer" }, "sha256": { "type": "string" }, "downloadPath": { "type": "string" }, "attestationPath": { "type": "string" }, "attestationDigest": { "type": "string" }, "source": { "type": "object", "additionalProperties": false, "required": [ "awardHash", "dispositionId", "awardRevision", "artifactSha256", "artifacts" ], "properties": { "awardHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "dispositionId": { "type": "string" }, "awardRevision": { "type": "integer", "minimum": 1 }, "artifactSha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "artifacts": { "type": "array", "description": "Exactly one descriptor for each frozen source kind: pdf, docx, and json.", "minItems": 3, "maxItems": 3, "items": { "type": "object", "additionalProperties": false, "required": [ "artifactId", "kind", "mediaType", "byteLength", "sha256" ], "properties": { "artifactId": { "type": "string" }, "kind": { "type": "string", "enum": [ "pdf", "docx", "json" ] }, "mediaType": { "type": "string" }, "byteLength": { "type": "integer", "minimum": 1 }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } } } } } } } } }, "required": [ "id", "awardHash", "awardHashVersion", "awardRevision", "companionArtifacts" ] } }, "required": [ "caseId", "externalCaseId", "award" ] }, "requestId": { "type": "string" } }, "x-code-source": "lib/api/award-award-representation.ts" }, "CanonicalGetAwardJsonAttestationCanonicalResponse": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "properties": { "caseId": { "type": "string" }, "artifactId": { "type": "string" }, "attestation": { "$ref": "#/components/schemas/PartnerAwardArtifactAttestation" } }, "required": [ "caseId", "artifactId", "attestation" ] }, "requestId": { "type": "string" } }, "x-code-source": "lib/api/award-attestation-representation.ts" }, "CanonicalQuoteFilingFeeCanonicalResponse": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "properties": { "claimAmount": { "$ref": "#/components/schemas/FiatMoney" }, "declaratoryOnly": { "type": "boolean" }, "collectionMode": { "type": "string" }, "tier": { "type": "string" }, "rateBasisPoints": { "type": "string" }, "percentComponent": { "$ref": "#/components/schemas/FiatMoney" }, "floor": { "$ref": "#/components/schemas/FiatMoney" }, "baseFee": { "$ref": "#/components/schemas/FiatMoney" }, "panelSurchargeRateBasisPoints": { "type": "string" }, "panelSurcharge": { "$ref": "#/components/schemas/FiatMoney" }, "forumFee": { "$ref": "#/components/schemas/FiatMoney" }, "waived": { "type": "boolean" } }, "required": [ "claimAmount", "collectionMode", "tier", "rateBasisPoints", "percentComponent", "floor", "baseFee", "panelSurchargeRateBasisPoints", "panelSurcharge", "forumFee", "waived" ] }, "requestId": { "type": "string" } }, "x-code-source": "app/api/v2/fees/quote/route.ts" }, "CanonicalGetAgentOnlyConsentPacketResponse": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "properties": { "side": { "type": "string", "enum": [ "claimant", "respondent" ] }, "termsDigest": { "type": "string" }, "acceptanceStatement": { "type": "string" }, "reviewPacket": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "draftId", "caseId", "draftDigest", "parties", "agentOfRecord", "preparingPartnerId", "claimSummary", "claimStatement", "requestedItems", "amount", "rules", "procedure", "aiDisclosure", "fees", "requiredConfirmations", "scope", "expiresAt", "termsDigest", "acceptanceStatement", "walletMessage" ], "properties": { "schemaVersion": { "type": "string", "const": "filing-review-packet-v1" }, "draftId": { "type": "string" }, "caseId": { "type": "string" }, "draftDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "parties": { "type": "object", "additionalProperties": false, "required": [ "claimant", "respondent" ], "properties": { "claimant": { "type": "object", "additionalProperties": false, "required": [ "principalId", "name" ], "properties": { "principalId": { "type": "string" }, "name": { "type": "string" } } }, "respondent": { "type": "object", "additionalProperties": false, "required": [ "principalId", "name" ], "properties": { "principalId": { "type": "string" }, "name": { "type": "string" } } } } }, "agentOfRecord": { "type": "string" }, "preparingPartnerId": { "type": "string" }, "claimSummary": { "type": "string" }, "claimStatement": { "type": "string" }, "requestedItems": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "kind", "text" ], "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "refund", "release", "split", "other", "monetary", "declaratory", "order" ] }, "text": { "type": "string" }, "amount": { "$ref": "#/components/schemas/FiatMoney" } } } }, "amount": { "$ref": "#/components/schemas/FiatMoney" }, "rules": { "type": "object", "additionalProperties": false, "required": [ "version", "hash" ], "properties": { "version": { "type": "string" }, "hash": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "procedure": { "type": "object", "additionalProperties": false, "required": [ "name", "finalityPath", "configuration" ], "properties": { "name": { "type": "string", "enum": [ "standard", "agent_only" ] }, "finalityPath": { "type": "string", "enum": [ "human_appeal", "agent_finality" ] }, "configuration": { "type": "object", "additionalProperties": true }, "agentFinalityTerms": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Exact registered Rules, behavior and disclosure tuple, including its termsHash." } } }, "aiDisclosure": { "type": "object", "additionalProperties": false, "required": [ "version", "hash" ], "properties": { "version": { "type": "string" }, "hash": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "fees": { "type": "object", "additionalProperties": true }, "requiredConfirmations": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "side", "principalId", "required", "statement" ], "properties": { "side": { "type": "string", "enum": [ "claimant", "respondent" ] }, "principalId": { "type": "string" }, "required": { "type": "boolean" }, "statement": { "type": "string" } } } }, "scope": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" }, "termsDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "acceptanceStatement": { "type": "string" }, "walletMessage": { "type": "string" } } } }, "required": [ "side", "termsDigest", "acceptanceStatement", "reviewPacket" ] }, "requestId": { "type": "string" } }, "x-code-source": "lib/api/agent-only-consent.ts" }, "CanonicalAcceptAgentOnlyFilingResponse": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "properties": { "accepted": { "const": true }, "side": { "type": "string", "enum": [ "claimant", "respondent" ] }, "termsDigest": { "type": "string" } }, "required": [ "accepted", "side", "termsDigest" ] }, "requestId": { "type": "string" } }, "x-code-source": "app/api/filings/[id]/agent-consents/route.ts" }, "CanonicalHostedRecordBundleManifest": { "type": "object", "properties": { "schemaVersion": { "const": "case-record-bundle-v1" }, "recipe": { "const": "sha256-canonical-json-v1" }, "sourceGraphVersion": { "const": "case-record-source-graph-v1" }, "disputeId": { "type": "string" }, "dispositionId": { "type": "string" }, "caseRevision": { "type": "integer" }, "awardRevision": { "type": "integer" }, "profile": { "type": "string", "enum": [ "party", "reviewer", "court" ] }, "partySide": { "type": "string", "enum": [ "claimant", "respondent" ] }, "sourceSnapshotHash": { "type": "string" }, "rules": { "type": "object", "properties": { "version": { "type": "string" }, "sha256": { "type": "string" } } }, "snapshotAt": { "type": "string" }, "files": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "mediaType": { "type": "string" }, "byteLength": { "type": "integer" }, "sha256": { "type": "string" }, "sourceSha256": { "type": "string" }, "sourceId": { "type": "string" }, "category": { "type": "string" } } } }, "exclusions": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "sourceId": { "type": "string" }, "detail": { "type": "string" } } } }, "bundleId": { "type": "string" }, "bundleHash": { "type": "string" } } } }, "responses": { "Ap2ResolutionCase": { "description": "Existing Partner API case opened after independent AP2 verification and bilateral resolution authorization.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/Ap2ResolutionCaseV1" }, "requestId": { "type": "string" } } } } } }, "UcpResolutionCase": { "description": "Existing Partner API case opened after independent UCP Order verification and bilateral resolution authorization.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/UcpResolutionCaseV1" }, "requestId": { "type": "string" } } } } } }, "ResolutionResult": { "description": "Existing Award finality remedy and separate execution projection.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "data", "requestId" ], "properties": { "data": { "$ref": "#/components/schemas/ResolutionResultV1" }, "requestId": { "type": "string" } } } } } }, "Data": { "description": "Versioned data envelope.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": {}, "requestId": { "type": "string" } } } } } }, "Problem": { "description": "RFC 9457 style problem response.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }