POSTlive

Prepare a claimant filing draft

Prepare a claimant filing draft.

/api/v2/filings/prepareprepareFilingV2

Authentication and authority

Send one of the allowed bearer credential roles. Alternatives are OR; credentials named within 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.

Parameters

NameLocationRequirementSchema
Idempotency-KeyheaderRequired{"type":"string","minLength":8,"maxLength":200}

Request body

Required request body.

application/json

{
  "$ref": "#/components/schemas/PrepareFiling",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "externalCaseId",
    "transactionId",
    "policyVersion",
    "authorityGrantId",
    "consentArtifactIds",
    "summary",
    "claimAmount",
    "parties",
    "claim"
  ],
  "properties": {
    "externalCaseId": {
      "type": "string"
    },
    "transactionId": {
      "type": "string"
    },
    "policyVersion": {
      "type": "string"
    },
    "authorityGrantId": {
      "type": "string"
    },
    "consentArtifactIds": {
      "$ref": "#/components/schemas/ConsentArtifactIds",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "claimant",
        "respondent"
      ],
      "properties": {
        "claimant": {
          "type": "string"
        },
        "respondent": {
          "type": "string"
        }
      }
    },
    "summary": {
      "type": "string"
    },
    "backgroundFacts": {
      "type": "string"
    },
    "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"
            }
          }
        }
      }
    },
    "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"
      }
    }
  }
}

Responses

201

Versioned data envelope.

application/json

{
  "type": "object",
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {},
    "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": {},
  "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.