POSTpartial

Prepare a filing

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.

/api/filingsprepareFilingPreview

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.

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
Idempotency-KeyheaderRequired{"type":"string","minLength":8,"maxLength":200}
x-pc-compatibility

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.

headerOptional{"type":"string","enum":["v1"]}

Request body

Required request body.

application/json

{
  "$ref": "#/components/schemas/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",
      "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": {
      "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"
              ]
            },
            "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",
              "type": "string",
              "enum": [
                "individual",
                "organization",
                "autonomous_agent"
              ]
            },
            "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",
      "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": {
      "type": "string",
      "enum": [
        "standard",
        "agent_only"
      ]
    },
    "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": [
          "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",
            "type": "string",
            "enum": [
              "claimant_representative",
              "respondent_representative"
            ]
          }
        }
      }
    },
    "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."
    },
    "schedule": {
      "$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
        }
      }
    }
  },
  "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": {
                  "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",
                  "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"
                }
              }
            }
          }
        }
      ]
    },
    {
      "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."
}

Responses

201

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