201
Versioned data envelope.
application/json
{
"type": "object",
"required": [
"data",
"requestId"
],
"properties": {
"data": {},
"requestId": {
"type": "string"
}
}
}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.
/api/v2/case-draftscreateCaseDraftV2Authentication and authority
Send one of the allowed bearer credential roles. Alternatives are OR; credentials named within one alternative are AND.
platformOrchestratorBearerCredential bound to the platform_orchestrator role.
claimantAgentBearerCredential bound to the claimant_agent role. Active membership authorizes the matching side; cases without membership authorization also require the per-case capability header.
Parameters
| Name | Location | Requirement | Schema |
|---|---|---|---|
Idempotency-Key | header | Required | {"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,
"required": [
"claimant"
],
"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/ClaimInput",
"type": "object",
"additionalProperties": false,
"required": [
"statement",
"requestedOutcome"
],
"properties": {
"statement": {
"type": "string"
},
"requestedOutcome": {
"type": "string",
"enum": [
"refund",
"release",
"split",
"other"
]
}
}
},
"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"
}
}
}
},
"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": {},
"label": {},
"settlementAction": {}
}
}
},
"evidencePolicy": {
"$ref": "#/components/schemas/NarrowEvaluationEvidencePolicyInput",
"type": "object",
"additionalProperties": false,
"properties": {
"sources": {
"type": "array",
"minItems": 1,
"maxItems": 2,
"uniqueItems": true,
"items": {}
},
"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"
}
}
}
}
},
"allOf": [
{
"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"
},
"participants": {
"$ref": "#/components/schemas/HostedCaseDraftParticipants"
}
}
},
{
"title": "Respondent consent was registered in advance",
"properties": {
"consentArtifactIds": {
"$ref": "#/components/schemas/ConsentArtifactIds"
}
}
}
]
},
{
"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": [
"claimant",
"respondent"
],
"properties": {
"claimant": {},
"respondent": {}
}
}
}
}
]
}
],
"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
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": {},
"requestId": "requestId_test"
}Usage notes
- Responses reflect the current authoritative resource state.
- 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.