201
The case opened. Initial capabilities are returned once and are omitted from idempotency replays.
application/json
{
"$ref": "#/components/schemas/ConfirmedCaseDraftEnvelope",
"type": "object",
"additionalProperties": false,
"required": [
"data",
"requestId"
],
"properties": {
"data": {
"$ref": "#/components/schemas/ConfirmedCaseDraft",
"type": "object",
"additionalProperties": false,
"required": [
"schemaVersion",
"caseId",
"externalCaseId",
"status",
"rules",
"createdAt",
"headless",
"caseMode",
"intakeMode",
"confirmationPolicy",
"procedure",
"participants"
],
"properties": {
"schemaVersion": {
"type": "string",
"const": "confirmed-filing-v2"
},
"caseId": {
"type": "string"
},
"externalCaseId": {
"type": "string"
},
"status": {
"type": "string"
},
"rules": {
"$ref": "#/components/schemas/CaseDraftRulesStamp",
"type": "object",
"additionalProperties": false,
"required": [
"version",
"hash"
],
"properties": {
"version": {
"type": "string"
},
"hash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"feeCoverage": {
"$ref": "#/components/schemas/SponsorshipFeeCoverage",
"type": "object",
"additionalProperties": false,
"required": [
"referralAuthorizationId",
"status",
"sponsorDisplayName",
"feeAmount",
"partyAmountDue",
"agreementVersion",
"agreementHash",
"billableEvent"
],
"properties": {
"referralAuthorizationId": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"covered",
"settled"
]
},
"sponsorDisplayName": {
"type": "string"
},
"feeAmount": {
"$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})$"
}
}
},
"partyAmountDue": {
"$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})$"
}
}
},
"agreementVersion": {
"type": "integer",
"minimum": 1
},
"agreementHash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"billableEvent": {
"type": "string",
"const": "case_docketed"
}
}
},
"feeDisposition": {
"$ref": "#/components/schemas/PartnerFeeDisposition",
"type": "object",
"additionalProperties": false,
"required": [
"feeReferralAuthorizationId",
"assessedFee",
"partyAmountDue",
"collectionDisposition",
"label",
"agreementVersion",
"agreementHash"
],
"properties": {
"feeReferralAuthorizationId": {
"type": "string"
},
"assessedFee": {
"$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})$"
}
}
},
"partyAmountDue": {
"$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})$"
}
}
},
"collectionDisposition": {
"type": "string",
"enum": [
"party_due",
"party_paid",
"partner_covered_per_case",
"partner_covered_by_plan",
"forum_waived",
"cancelled"
]
},
"label": {
"type": "string"
},
"agreementVersion": {
"type": "integer",
"minimum": 1
},
"agreementHash": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
}
},
"feeChallenge": {
"$ref": "#/components/schemas/PartnerFeeCheckoutChallenge",
"type": "object",
"additionalProperties": false,
"required": [
"method",
"amount",
"caseId",
"checkoutEndpoint",
"httpMethod",
"requestBody",
"authorization"
],
"properties": {
"method": {
"type": "string",
"const": "fiat_card"
},
"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})$"
}
}
},
"caseId": {
"type": "string",
"description": "Public Partner API case ID accepted by checkoutEndpoint."
},
"checkoutEndpoint": {
"type": "string",
"const": "/api/v2/fees/stripe/checkout"
},
"httpMethod": {
"type": "string",
"const": "POST"
},
"requestBody": {
"$ref": "#/components/schemas/PartnerFilingCheckoutInput",
"type": "object",
"additionalProperties": false,
"required": [
"caseId"
],
"properties": {
"caseId": {
"type": "string",
"pattern": "^pcase_[A-Za-z0-9_-]{1,96}$",
"description": "Public Partner API case ID owned by the authenticated partner."
}
}
},
"authorization": {
"type": "string",
"const": "partner_bearer"
}
}
},
"headless": {
"type": "object",
"additionalProperties": false,
"required": [
"respondentHandoffPath",
"answerPath",
"capabilityDelivery"
],
"properties": {
"respondentHandoffPath": {
"type": "string"
},
"answerPath": {
"type": "string"
},
"hostedRespondentPath": {
"type": "string"
},
"capabilityDelivery": {
"type": "string",
"const": "show_once_not_replayed"
}
}
},
"caseMode": {
"type": "string",
"enum": [
"proceeding",
"evaluation"
]
},
"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/ResolvedCaseProcedure",
"type": "object",
"additionalProperties": false,
"required": [
"schemaVersion",
"profile",
"answerRequired",
"evidenceRounds",
"rebuttalRounds",
"filingsPerSidePerStage",
"recordConfirmationRequired"
],
"properties": {
"schemaVersion": {
"type": "string",
"const": "case-procedure-plan-v2"
},
"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
}
}
},
"participants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CaseDraftParticipantResource",
"type": "object",
"additionalProperties": false,
"required": [
"participantId",
"side",
"principalId",
"authorizationMode"
],
"properties": {
"participantId": {
"type": "string"
},
"side": {
"type": "string",
"enum": [
"claimant",
"respondent"
]
},
"partnerId": {
"type": "string"
},
"principalId": {
"type": "string"
},
"agentId": {
"type": "string"
},
"authorizationMode": {
"type": "string",
"enum": [
"partner_credential",
"hosted_account"
]
}
}
}
},
"evaluation": {
"type": "object",
"additionalProperties": false,
"required": [
"externalEvaluationId",
"evaluationDigest",
"resourcePath"
],
"properties": {
"externalEvaluationId": {
"type": "string"
},
"evaluationDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"resourcePath": {
"type": "string"
}
}
},
"showOnce": {
"$ref": "#/components/schemas/InitialCaseCapabilities",
"type": "object",
"additionalProperties": false,
"description": "Sensitive capabilities returned only on the initial successful response and never on idempotency replay.",
"properties": {
"claimantPartyToken": {
"type": "string"
},
"respondentInviteToken": {
"type": "string"
},
"respondentLoginPath": {
"type": "string",
"description": "Tokenized hosted login path for the invited respondent."
}
}
}
}
},
"requestId": {
"type": "string"
}
}
}