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

POSTpartial

Submit a stage-bound party brief and evidence

File the acting party’s brief and evidence in the permitted stage. Session requests use the displayed declaration fields; bearer requests use protocol certification and require x-pc-party and Idempotency-Key. Each request checks the current stage and case revision.

/api/cases/{id}/submissionsfileSubmissionPreview

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.

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.

CanonicalSession

The signed-in account’s session. Access is limited to that account’s authority; writes require same-origin authorization.

AccountOAuth

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

Parameters

NameLocationRequirementSchema
idpathRequired{"type":"string"}
Idempotency-Key

Required for bearer requests. Hosted submission behavior is unchanged.

headerOptional{"type":"string"}
x-pc-party

Required for bearer credentials.

headerOptional{"type":"string","enum":["claimant","respondent"]}
x-arb-party-token

Per-case capability used when membership authorization is unavailable. Optional with active membership for the matching side.

headerOptional{"type":"string"}

Request body

Required request body.

multipart/form-data

{
  "$ref": "#/components/schemas/CanonicalSubmissionForm",
  "type": "object",
  "required": [
    "party",
    "brief"
  ],
  "properties": {
    "party": {
      "type": "string",
      "enum": [
        "claimant",
        "respondent"
      ]
    },
    "brief": {
      "type": "string"
    },
    "files": {
      "type": "array",
      "items": {
        "type": "string",
        "contentEncoding": "binary"
      }
    },
    "evidenceCandidateRefs": {
      "type": "string",
      "description": "JSON array of exportRecordId and artifactRef objects."
    },
    "attest": {
      "type": "string",
      "const": "true",
      "description": "Required for hosted-session and account-OAuth human declarations. The person must explicitly affirm truthfulness; never infer or default it. Partner protocol filings use their separately authorized certification."
    },
    "declarantName": {
      "type": "string"
    },
    "declarantCapacity": {
      "type": "string"
    },
    "executionLocation": {
      "type": "string"
    }
  }
}

Responses

201

Committed party submission.

application/json

{
  "$ref": "#/components/schemas/CanonicalFileSubmissionPreviewResponse",
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/CanonicalSubmissionResult",
      "type": "object",
      "properties": {
        "schemaVersion": {
          "type": "string"
        },
        "submission": {
          "$ref": "#/components/schemas/CanonicalSubmission",
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "disputeId": {
              "type": "string"
            },
            "party": {
              "type": "string",
              "enum": [
                "claimant",
                "respondent"
              ]
            },
            "brief": {
              "type": "string"
            },
            "evidenceIds": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "submittedAt": {
              "type": "string"
            },
            "phase": {
              "type": "string"
            },
            "sealedAt": {
              "type": "string"
            },
            "revealedAt": {
              "type": "string"
            },
            "contentHash": {
              "type": "string"
            },
            "supersededAt": {
              "type": "string"
            },
            "supersededBy": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "party",
            "brief",
            "evidenceIds",
            "submittedAt"
          ]
        },
        "evidence": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "phase": {
                "type": "string"
              },
              "reliabilityTier": {
                "type": "string"
              },
              "contentHash": {
                "type": "string"
              },
              "extractionError": {
                "type": "string"
              },
              "withholdingNotice": {
                "type": "object",
                "description": "Plain-language reason this exhibit is withheld from the considered Record, with guidance for the submitting party.",
                "properties": {
                  "reason": {
                    "type": "string"
                  },
                  "action": {
                    "type": "string"
                  }
                },
                "required": [
                  "reason",
                  "action"
                ]
              },
              "neutralizedCount": {
                "type": "integer"
              }
            },
            "required": [
              "id",
              "label",
              "phase",
              "reliabilityTier",
              "contentHash",
              "neutralizedCount"
            ]
          }
        },
        "security": {
          "type": "object",
          "properties": {
            "neutralizedCount": {
              "type": "integer"
            },
            "quarantinedExhibits": {
              "type": "integer"
            },
            "attributableTo": {
              "type": "string",
              "enum": [
                "claimant",
                "respondent"
              ]
            }
          },
          "required": [
            "neutralizedCount",
            "quarantinedExhibits"
          ]
        },
        "sealed": {
          "type": "boolean"
        },
        "phase": {
          "type": "string"
        },
        "deadlines": {
          "type": "object",
          "properties": {
            "answer": {
              "type": "string"
            },
            "evidence": {
              "type": "string"
            },
            "rebuttal": {
              "type": "string"
            }
          }
        },
        "evidenceCandidateAdoptions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "exportRecordId": {
                "type": "string"
              },
              "artifactRef": {
                "type": "string"
              },
              "evidenceObjectId": {
                "type": "string"
              },
              "sourceSha256": {
                "type": "string"
              }
            },
            "required": [
              "exportRecordId",
              "artifactRef",
              "evidenceObjectId",
              "sourceSha256"
            ]
          }
        }
      },
      "required": [
        "submission"
      ]
    },
    "requestId": {
      "type": "string"
    }
  },
  "required": [
    "data",
    "requestId"
  ]
}
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": {
    "submission": {
      "id": "id_test",
      "party": "claimant",
      "brief": "The attached test record supports this position.",
      "evidenceIds": [
        "evidenceIds_test"
      ],
      "submittedAt": "submittedAt_test"
    }
  },
  "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: Review the side’s restatement →