GETlive

List immutable shared procedural messages

Messages are ordered by creation time and ID. They are not part of, and do not mutate, the merits record.

/api/v2/cases/{caseId}/messageslistProceduralMessagesV2

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.

respondentAgentBearer

Credential bound to the respondent_agent role. Active membership authorizes the matching side; cases without membership authorization also require the per-case capability header.

Parameters

NameLocationRequirementSchema
caseIdpathRequired{"type":"string"}

Responses

200

Case-scoped procedural messages.

application/json

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "messages",
        "recordEffect"
      ],
      "properties": {
        "messages": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/PartnerProceduralMessage",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "schemaVersion",
              "id",
              "caseId",
              "partnerId",
              "senderKind",
              "senderCredentialPublicId",
              "category",
              "text",
              "evidenceIds",
              "messageDigest",
              "recordEffect",
              "createdAt"
            ],
            "properties": {
              "schemaVersion": {
                "type": "string",
                "const": "partner-procedural-message-v2"
              },
              "id": {
                "type": "string"
              },
              "caseId": {
                "type": "string"
              },
              "partnerId": {
                "type": "string"
              },
              "senderKind": {
                "type": "string",
                "enum": [
                  "party",
                  "platform"
                ]
              },
              "senderSide": {
                "type": "string",
                "enum": [
                  "claimant",
                  "respondent"
                ]
              },
              "senderCredentialPublicId": {
                "type": "string",
                "description": "Public credential identity; the internal persistence identifier is never returned."
              },
              "category": {
                "type": "string",
                "enum": [
                  "clarification_request",
                  "clarification_response",
                  "evidence_request",
                  "procedural_notice",
                  "settlement_coordination"
                ]
              },
              "text": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              },
              "replyToMessageId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "evidenceIds": {
                "type": "array",
                "maxItems": 8,
                "uniqueItems": true,
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 200
                }
              },
              "messageDigest": {
                "type": "string",
                "pattern": "^[a-f0-9]{64}$"
              },
              "recordEffect": {
                "type": "string",
                "const": "none"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "recordEffect": {
          "type": "string",
          "const": "none"
        }
      }
    },
    "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": {
    "messages": [
      {
        "schemaVersion": "partner-procedural-message-v2",
        "id": "id_test",
        "caseId": "case_test_123",
        "partnerId": "partner_test_123",
        "senderKind": "party",
        "senderCredentialPublicId": "senderCredentialPublicId_test",
        "category": "clarification_request",
        "text": "Test-environment procedural message.",
        "evidenceIds": [
          "evidenceIds_test"
        ],
        "messageDigest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "recordEffect": "none",
        "createdAt": "2026-08-09T12:00:00.000Z"
      }
    ],
    "recordEffect": "none"
  },
  "requestId": "requestId_test"
}

Usage notes

  • Responses reflect the current authoritative resource state.