POSTpartial

Open a party filing through the hosted account contract

Flag-gated party filing through the existing account boundary. OAuth requires both filings:write and consents:write plus exact case acceptance. Tokens with standing bounds must instead accept a prepared packet through /api/authorizations/consents, preserving bounds, notice and opening-time revocation guards.

/api/casescreateAccountCase

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.

CanonicalSession

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

This operation has no path, query, or header parameters.

Request body

Required request body.

application/json

{
  "type": "object",
  "properties": {
    "flow": {
      "type": "string",
      "const": "party"
    },
    "summary": {
      "type": "string"
    },
    "backgroundFacts": {
      "type": "string"
    },
    "governingLaw": {
      "type": "string",
      "enum": [
        "platform_native",
        "common_law_contract",
        "custom_terms",
        "english_law",
        "singapore_law",
        "new_york_law",
        "delaware_law"
      ]
    },
    "customTerms": {
      "type": "string"
    },
    "disputeAmount": {
      "type": "number",
      "minimum": 0
    },
    "currency": {
      "type": "string"
    },
    "escrowMode": {
      "type": "string",
      "enum": [
        "simulation",
        "testnet",
        "mainnet",
        "none"
      ]
    },
    "remedialJurisdictionOptIn": {
      "type": "boolean"
    },
    "agree": {
      "type": "boolean",
      "const": true
    },
    "track": {
      "type": "string",
      "enum": [
        "standard",
        "fast",
        "agent"
      ]
    },
    "hasPrincipal": {
      "type": "boolean"
    },
    "principalCompressedClockConsent": {
      "type": "boolean"
    },
    "feeMethod": {
      "type": "string",
      "const": "fiat_card"
    },
    "claimant": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "type": {
          "type": "string",
          "enum": [
            "human",
            "entity",
            "agent"
          ]
        },
        "position": {
          "type": "string"
        },
        "evidence": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "relief": {
          "type": "string"
        },
        "orderRelief": {
          "type": "string"
        },
        "declaratoryRelief": {
          "type": "string"
        },
        "walletAddress": {
          "type": "string"
        },
        "webhookUrl": {
          "type": "string"
        },
        "attest": {
          "type": "boolean",
          "const": true
        },
        "declarantName": {
          "type": "string"
        },
        "declarantCapacity": {
          "type": "string"
        },
        "executionLocation": {
          "type": "string"
        }
      },
      "required": [
        "name",
        "position",
        "attest",
        "declarantName",
        "declarantCapacity",
        "executionLocation"
      ]
    },
    "respondent": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "email": {
          "type": "string",
          "format": "email"
        },
        "emailIsProper": {
          "type": "boolean"
        },
        "emailSource": {
          "type": "string",
          "enum": [
            "claimant_attested",
            "agreement",
            "notice_designation"
          ]
        }
      },
      "required": []
    },
    "respondentPreDisputeConsent": {
      "type": "object",
      "description": "Existing pinned respondent ConsentAttestation, verified by the hosted filing operation."
    }
  },
  "required": [
    "flow",
    "summary",
    "governingLaw",
    "disputeAmount",
    "escrowMode",
    "claimant",
    "agree"
  ]
}

Responses

200

Hosted creation result.

application/json

{
  "type": "object",
  "properties": {
    "ok": {
      "const": true
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "status": {
          "type": "string"
        },
        "filingFeePending": {
          "type": "boolean"
        },
        "feeChallenge": {
          "type": "object",
          "properties": {
            "method": {
              "type": "string"
            },
            "feeRecordId": {
              "type": "string"
            },
            "amountUsd": {
              "type": "number"
            },
            "deadlineAt": {
              "type": "string"
            },
            "checkoutEndpoint": {
              "type": "string"
            }
          }
        },
        "track": {
          "type": "string"
        },
        "respondentPreDisputeConsentAccepted": {
          "type": "boolean"
        },
        "noticeQueued": {
          "type": "boolean"
        },
        "noticeAddressMasked": {
          "type": "string"
        },
        "idempotencyReplayed": {
          "type": "boolean"
        },
        "capabilitiesReturned": {
          "type": "boolean"
        },
        "claimantToken": {
          "type": "string"
        },
        "inviteToken": {
          "type": "string"
        },
        "invitePath": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "status"
      ]
    }
  },
  "required": [
    "ok",
    "data"
  ]
}
201

Case created.

application/json

{
  "type": "object",
  "properties": {
    "ok": {
      "const": true
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "status": {
          "type": "string"
        },
        "filingFeePending": {
          "type": "boolean"
        },
        "feeChallenge": {
          "type": "object",
          "properties": {
            "method": {
              "type": "string"
            },
            "feeRecordId": {
              "type": "string"
            },
            "amountUsd": {
              "type": "number"
            },
            "deadlineAt": {
              "type": "string"
            },
            "checkoutEndpoint": {
              "type": "string"
            }
          }
        },
        "track": {
          "type": "string"
        },
        "respondentPreDisputeConsentAccepted": {
          "type": "boolean"
        },
        "noticeQueued": {
          "type": "boolean"
        },
        "noticeAddressMasked": {
          "type": "string"
        },
        "idempotencyReplayed": {
          "type": "boolean"
        },
        "capabilitiesReturned": {
          "type": "boolean"
        },
        "claimantToken": {
          "type": "string"
        },
        "inviteToken": {
          "type": "string"
        },
        "invitePath": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "status"
      ]
    }
  },
  "required": [
    "ok",
    "data"
  ]
}
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

{
  "ok": true,
  "data": {
    "id": "id_test",
    "status": "status_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.
  • The request is accepted only when its credential, authority, case state, and resource preconditions are satisfied.