POSTlive

Confirm and open a prepared claimant filing

Confirm and open a prepared claimant filing.

/api/v2/filings/{draftId}/confirmconfirmFilingV2

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
draftIdpathRequired{"type":"string"}
Idempotency-KeyheaderRequired{"type":"string","minLength":8,"maxLength":200}

Request body

Required request body.

application/json

{
  "$ref": "#/components/schemas/FilingConfirmation",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "draftDigest",
    "confirmationStatement",
    "actorId",
    "principalId",
    "confirmationMethod",
    "confirmationReference"
  ],
  "properties": {
    "draftDigest": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "confirmationStatement": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1000
    },
    "actorId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "Must equal the immutable claimant authority agent ID."
    },
    "principalId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "confirmationMethod": {
      "type": "string",
      "const": "protocol_act"
    },
    "confirmationReference": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    }
  }
}

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.