GETpartial

Read a case draft and its confirmation state

Flag-gated canonical alias over the existing operation, with the same authorization, persistence and retry identity.

/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 case scope. S256 PKCE is mandatory on the code flow. Explicit reacceptance is required after Rules/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"
      ],
      "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",
                  "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": "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",
          "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",
              "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": [
                    "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"
            }
          }
        }
      }
    },
    "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"
    }
  }
}

Example response

Successful response

{
  "data": {
    "schemaVersion": "filing-v1",
    "draftId": "draft_test_123",
    "draftDigest": "draftDigest_test",
    "procedure": "standard",
    "schedule": {
      "profile": "standard"
    },
    "parties": {
      "claimant": {
        "externalId": "externalId_test",
        "name": "name_test",
        "principalKind": "individual"
      },
      "respondent": {
        "externalId": "externalId_test",
        "name": "name_test",
        "principalKind": "individual"
      }
    }
  },
  "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.