POSTlive

Create a configurable case draft

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. Compatibility 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.

/api/v2/case-draftscreateCaseDraftV2

Authentication and authority

Send one of the allowed bearer credential roles. Alternatives are OR; credentials named within 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.

Parameters

NameLocationRequirementSchema
Idempotency-KeyheaderRequired{"type":"string","minLength":8,"maxLength":200}

Request body

Required request body.

application/json

{
  "$ref": "#/components/schemas/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",
      "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."
        }
      }
    },
    "claimAmount": {
      "$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})$"
        }
      }
    },
    "parties": {
      "$ref": "#/components/schemas/CasePartiesInput",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "claimant",
        "respondent"
      ],
      "properties": {
        "claimant": {
          "$ref": "#/components/schemas/CasePartyInput",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "externalId",
            "name"
          ],
          "properties": {
            "externalId": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "respondent": {
          "$ref": "#/components/schemas/CasePartyInput",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "externalId",
            "name"
          ],
          "properties": {
            "externalId": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        }
      }
    },
    "summary": {
      "type": "string"
    },
    "backgroundFacts": {
      "type": "string"
    },
    "claim": {
      "$ref": "#/components/schemas/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
              }
            }
          }
        }
      }
    },
    "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",
      "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
        }
      }
    },
    "evaluation": {
      "$ref": "#/components/schemas/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",
                "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
                  }
                }
              }
            }
          }
        },
        "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",
            "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"
                    ]
                  }
                }
              }
            }
          }
        },
        "evidencePolicy": {
          "$ref": "#/components/schemas/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
            }
          }
        },
        "reviewPolicy": {
          "$ref": "#/components/schemas/NarrowEvaluationReviewPolicyInput",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "initialPath": {
              "type": "string",
              "const": "adjudicative",
              "default": "adjudicative"
            },
            "humanReviewRequired": {
              "type": "boolean",
              "const": false,
              "default": false
            }
          }
        }
      }
    },
    "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": {
      "$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}$"
        }
      },
      "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."
    },
    "caseTrack": {
      "$ref": "#/components/schemas/CaseTrack",
      "type": "string",
      "enum": [
        "ai_fast",
        "ai_standard",
        "ai_assisted_human"
      ],
      "description": "Select AI-only (ai_standard or ai_fast, also the default) or ai_assisted_human. Before consent, the server assigns eligible AI-only monetary cases below USD 100 to ai_fast and other cases to ai_standard. Both parties accept the exact resolved procedure and fee terms.",
      "default": "ai_standard"
    },
    "appealWaived": {
      "type": "boolean",
      "default": false,
      "description": "Separate proposed internal human appeal waiver; effective only after both parties expressly accept the exact procedure tuple."
    }
  },
  "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",
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "claimant": {
                      "type": "string"
                    }
                  }
                },
                "participants": {
                  "$ref": "#/components/schemas/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"
                          }
                        }
                      }
                    ]
                  }
                }
              }
            },
            {
              "title": "Respondent consent was registered in advance",
              "properties": {
                "consentArtifactIds": {
                  "$ref": "#/components/schemas/ConsentArtifactIds",
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "respondent"
                  ],
                  "properties": {
                    "claimant": {
                      "type": "string"
                    },
                    "respondent": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          ]
        },
        {
          "title": "Bilaterally authorized or claimant-proposed case",
          "properties": {
            "intakeMode": {
              "type": "string",
              "enum": [
                "claimant_proposed",
                "bilateral_api",
                "bundled_bilateral"
              ]
            },
            "consentArtifactIds": {
              "$ref": "#/components/schemas/ConsentArtifactIds",
              "type": "object",
              "additionalProperties": false,
              "required": [
                "respondent"
              ],
              "properties": {
                "claimant": {
                  "type": "string"
                },
                "respondent": {
                  "type": "string"
                }
              }
            }
          }
        }
      ]
    }
  ],
  "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"
        }
      }
    }
  ]
}

Responses

201

Prepared packet. Claimant acceptance is required before confirmation opens the case.

application/json

{
  "$ref": "#/components/schemas/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",
          "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}$"
                }
              }
            }
          }
        },
        "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"
    }
  }
}
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": {
    "draftId": "draft_test_123",
    "draftDigest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "reviewPacket": {
      "schemaVersion": "filing-review-packet-v1",
      "draftId": "draft_test_123",
      "caseId": "pcase_test_123",
      "draftDigest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "parties": {
        "claimant": {
          "principalId": "principal_test_123",
          "name": "Maya Chen"
        },
        "respondent": {
          "principalId": "principal_test_123",
          "name": "Northwind Goods"
        }
      },
      "claimantIdentity": {
        "email": "maya.chen@example.com"
      },
      "agentOfRecord": "agentOfRecord_test",
      "preparingPartnerId": "partner_test_123",
      "claimSummary": "Test-environment contract delivery dispute.",
      "claimStatement": "The test delivery did not match the agreed specification.",
      "requestedItems": [
        {
          "id": "id_test",
          "kind": "refund",
          "text": "Test-environment procedural message."
        }
      ],
      "amount": {
        "currency": "USD",
        "minorUnits": "12500"
      },
      "rules": {
        "version": "version_test",
        "hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
      },
      "procedure": {
        "name": "ai_fast",
        "finalityPath": "human_appeal",
        "configuration": {}
      },
      "aiDisclosure": {
        "version": "version_test",
        "hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
      },
      "fees": {},
      "requiredConfirmations": [
        {
          "side": "claimant",
          "principalId": "principal_test_123",
          "required": false,
          "statement": "The test delivery did not match the agreed specification."
        }
      ],
      "scope": "scope_test",
      "expiresAt": "2026-08-09T12:00:00.000Z",
      "termsDigest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "acceptanceStatement": "The test delivery did not match the agreed specification.",
      "walletMessage": "walletMessage_test",
      "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.
  • Send a unique Idempotency-Key. An exact retry returns the stored result; reusing the key with a different request fails.
  • The request is accepted only when its credential, authority, case state, and resource preconditions are satisfied.

Likely next action: Read the canonical draft before confirmation →