For the complete documentation index, see llms.txt. This page is also available as Markdown.

GETpartial

Read a case draft and its confirmation state

Read the filing packet, its digest and the remaining participant confirmations under the caller’s authority.

/api/filings/{id}getFilingPreview

Authentication and authority

Use one listed account-session, scoped OAuth, or partner credential alternative. Account tokens retain the approving account’s authority. Cookie-authenticated writes require same-origin authorization. Alternatives are OR; schemes in one alternative are AND.

platformOrchestratorBearer

Credential bound to the platform_orchestrator role.

claimantAgentBearer

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

Credential bound to the respondent_agent role. Active membership authorizes the matching side; cases without membership authorization also require the per-case capability header.

AccountOAuth

Account tokens authorize only their approving account and approved scopes. S256 PKCE is mandatory on the code flow. Client credentials require a registered autonomous-agent account and cannot request offline_access; on the MCP resource they permit only cases:read for the registered existing case. Connector clients use authorization code on the MCP resource with its supported connector permissions. Explicit reacceptance is required after Rules or disclosure changes.

Parameters

NameLocationRequirementSchema
idpathRequired{"type":"string"}

Responses

200

Canonical filing preparation state

application/json

{
  "type": "object",
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/CanonicalPreparedFiling",
      "type": "object",
      "additionalProperties": true,
      "required": [
        "schemaVersion",
        "draftId",
        "draftDigest",
        "procedure",
        "schedule",
        "parties",
        "caseTrack",
        "appealWaived",
        "procedureTerms"
      ],
      "properties": {
        "schemaVersion": {
          "type": "string",
          "const": "filing-v1"
        },
        "draftId": {
          "type": "string"
        },
        "draftDigest": {
          "type": "string"
        },
        "procedure": {
          "type": "string",
          "enum": [
            "ai_fast",
            "ai_standard",
            "ai_assisted_human"
          ]
        },
        "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",
                  "type": "string",
                  "enum": [
                    "individual",
                    "organization",
                    "autonomous_agent"
                  ]
                }
              }
            },
            "respondent": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "externalId",
                "name",
                "principalKind"
              ],
              "properties": {
                "externalId": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "principalKind": {
                  "$ref": "#/components/schemas/CanonicalPrincipalKind",
                  "type": "string",
                  "enum": [
                    "individual",
                    "organization",
                    "autonomous_agent"
                  ]
                }
              }
            }
          }
        },
        "status": {
          "type": "string",
          "description": "Current filing preparation state. awaiting_agent_acceptances applies only to existing drafts already bound to the Agent-only procedure."
        },
        "agentConsentUrl": {
          "type": "string",
          "description": "Only for an existing draft already bound to the Agent-only procedure: each bound account uses its own OAuth token to read and accept its exact statement. Not issued for new preparations."
        },
        "hostedAcceptanceUrl": {
          "type": "string",
          "description": "Standard procedure: show-once claimant acceptance link, omitted on replay."
        },
        "reviewPacket": {
          "$ref": "#/components/schemas/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",
            "procedureTerms"
          ],
          "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",
              "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}$"
                }
              }
            },
            "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",
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "currency",
                      "minorUnits"
                    ],
                    "properties": {
                      "currency": {
                        "type": "string",
                        "const": "USD"
                      },
                      "minorUnits": {
                        "type": "string",
                        "pattern": "^(0|[1-9][0-9]{0,77})$"
                      }
                    }
                  }
                }
              }
            },
            "amount": {
              "$ref": "#/components/schemas/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})$"
                }
              }
            },
            "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": [
                    "ai_fast",
                    "ai_standard",
                    "ai_assisted_human"
                  ]
                },
                "finalityPath": {
                  "type": "string",
                  "enum": [
                    "human_appeal",
                    "appeal_waived"
                  ]
                },
                "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"
            },
            "procedureTerms": {
              "$ref": "#/components/schemas/CaseProcedureTerms",
              "type": "object",
              "additionalProperties": false,
              "required": [
                "schemaVersion",
                "track",
                "appealWaived",
                "waiverDisclosureVersion",
                "waiverDisclosureHash",
                "rulesVersion",
                "rulesHash",
                "behaviorVersion",
                "disclosureVersion",
                "disclosureHash",
                "feePolicyVersion",
                "termsHash"
              ],
              "properties": {
                "schemaVersion": {
                  "type": "string",
                  "const": "case-procedure-v1"
                },
                "track": {
                  "type": "string",
                  "enum": [
                    "ai_fast",
                    "ai_standard",
                    "ai_assisted_human"
                  ]
                },
                "appealWaived": {
                  "type": "boolean"
                },
                "waiverDisclosureVersion": {
                  "type": "string",
                  "minLength": 1
                },
                "waiverDisclosureHash": {
                  "type": "string",
                  "pattern": "^[a-f0-9]{64}$"
                },
                "rulesVersion": {
                  "type": "string",
                  "minLength": 1
                },
                "rulesHash": {
                  "type": "string",
                  "pattern": "^[a-f0-9]{64}$"
                },
                "behaviorVersion": {
                  "type": "string",
                  "minLength": 1
                },
                "disclosureVersion": {
                  "type": "string",
                  "minLength": 1
                },
                "disclosureHash": {
                  "type": "string",
                  "pattern": "^[a-f0-9]{64}$"
                },
                "feePolicyVersion": {
                  "type": "string",
                  "minLength": 1
                },
                "termsHash": {
                  "type": "string",
                  "pattern": "^[a-f0-9]{64}$"
                }
              }
            }
          }
        },
        "caseTrack": {
          "type": "string",
          "enum": [
            "ai_fast",
            "ai_standard",
            "ai_assisted_human"
          ]
        },
        "appealWaived": {
          "type": "boolean"
        },
        "procedureTerms": {
          "$ref": "#/components/schemas/CaseProcedureTerms",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "schemaVersion",
            "track",
            "appealWaived",
            "waiverDisclosureVersion",
            "waiverDisclosureHash",
            "rulesVersion",
            "rulesHash",
            "behaviorVersion",
            "disclosureVersion",
            "disclosureHash",
            "feePolicyVersion",
            "termsHash"
          ],
          "properties": {
            "schemaVersion": {
              "type": "string",
              "const": "case-procedure-v1"
            },
            "track": {
              "type": "string",
              "enum": [
                "ai_fast",
                "ai_standard",
                "ai_assisted_human"
              ]
            },
            "appealWaived": {
              "type": "boolean"
            },
            "waiverDisclosureVersion": {
              "type": "string",
              "minLength": 1
            },
            "waiverDisclosureHash": {
              "type": "string",
              "pattern": "^[a-f0-9]{64}$"
            },
            "rulesVersion": {
              "type": "string",
              "minLength": 1
            },
            "rulesHash": {
              "type": "string",
              "pattern": "^[a-f0-9]{64}$"
            },
            "behaviorVersion": {
              "type": "string",
              "minLength": 1
            },
            "disclosureVersion": {
              "type": "string",
              "minLength": 1
            },
            "disclosureHash": {
              "type": "string",
              "pattern": "^[a-f0-9]{64}$"
            },
            "feePolicyVersion": {
              "type": "string",
              "minLength": 1
            },
            "termsHash": {
              "type": "string",
              "pattern": "^[a-f0-9]{64}$"
            }
          }
        }
      }
    },
    "requestId": {
      "type": "string"
    }
  }
}
default

RFC 9457 style problem response.

application/problem+json

{
  "$ref": "#/components/schemas/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"
    },
    "details": {
      "description": "Account-readiness refusals include a value-free checklist and exact account-page link. Other error codes may provide different details.",
      "anyOf": [
        {
          "$ref": "#/components/schemas/AccountReadinessDetails",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "ready",
            "accountSetupUrl",
            "missing"
          ],
          "properties": {
            "ready": {
              "type": "boolean"
            },
            "accountSetupUrl": {
              "type": "string",
              "format": "uri"
            },
            "missing": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AccountReadinessRequirement",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "label",
                  "section",
                  "accountUrl"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "section": {
                    "type": "string",
                    "enum": [
                      "email",
                      "identity",
                      "legal_documents"
                    ]
                  },
                  "accountUrl": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              }
            }
          }
        },
        {
          "$ref": "#/components/schemas/LegalDocumentsRequiredDetails",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "legalDocumentsUrl"
          ],
          "properties": {
            "legalDocumentsUrl": {
              "type": "string",
              "format": "uri",
              "description": "Absolute account-page URL where the person reviews and accepts the current Terms and Privacy Notice. Uses the configured public application origin. After accepting the documents, retry the original operation."
            },
            "ready": {
              "type": "boolean"
            },
            "accountSetupUrl": {
              "type": "string",
              "format": "uri"
            },
            "missing": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AccountReadinessRequirement",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "label",
                  "section",
                  "accountUrl"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "section": {
                    "type": "string",
                    "enum": [
                      "email",
                      "identity",
                      "legal_documents"
                    ]
                  },
                  "accountUrl": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              }
            }
          }
        },
        {}
      ]
    }
  }
}

Example response

Successful response

{
  "data": {
    "schemaVersion": "filing-v1",
    "draftId": "draft_test_123",
    "draftDigest": "draftDigest_test",
    "procedure": "ai_fast",
    "schedule": {
      "profile": "standard"
    },
    "parties": {
      "claimant": {
        "externalId": "buyer_4821",
        "name": "Maya Chen",
        "principalKind": "individual"
      },
      "respondent": {
        "externalId": "seller_1187",
        "name": "Northwind Goods",
        "principalKind": "individual"
      }
    },
    "caseTrack": "ai_standard",
    "appealWaived": false,
    "procedureTerms": {
      "schemaVersion": "case-procedure-v1",
      "track": "ai_fast",
      "appealWaived": false,
      "waiverDisclosureVersion": "waiverDisclosureVersion_test",
      "waiverDisclosureHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "rulesVersion": "rulesVersion_test",
      "rulesHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "behaviorVersion": "behaviorVersion_test",
      "disclosureVersion": "disclosureVersion_test",
      "disclosureHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "feePolicyVersion": "2026-08-test",
      "termsHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    }
  },
  "requestId": "requestId_test"
}

Errors

Read the response status and stable error code. See errors and rate limits for recovery. Refresh the resource before resolving a state or digest conflict.

Idempotency and retries

  • For throttling, honor Retry-After when present. Back off on retryable server failures.

Likely next action: Confirm the participant and exact draft digest →