GETlive

Read the immutable evaluation definition and any served result

Returns pending or review state until an Award is served. A served result maps only to the three outcomes authorized in the evaluation draft. Compatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.

/api/v2/cases/{caseId}/evaluationgetNarrowEvaluationV2

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"}
x-arb-party-token

Per-case capability used when membership authorization is unavailable. Optional with active membership for the matching side.

headerOptional{"type":"string"}

Responses

200

Narrow evaluation state and result projection.

application/json

{
  "type": "object",
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/NarrowEvaluationResource",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "schemaVersion",
        "caseId",
        "externalCaseId",
        "externalEvaluationId",
        "evaluationDigest",
        "question",
        "allowedOutcomes",
        "evidencePolicy",
        "reviewPolicy",
        "record",
        "result"
      ],
      "properties": {
        "schemaVersion": {
          "type": "string",
          "const": "narrow-evaluation-resource-v2"
        },
        "caseId": {
          "type": "string"
        },
        "externalCaseId": {
          "type": "string"
        },
        "externalEvaluationId": {
          "type": "string"
        },
        "evaluationDigest": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        },
        "question": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "text",
            "criteria"
          ],
          "properties": {
            "text": {
              "type": "string"
            },
            "criteria": {
              "type": "array",
              "minItems": 1,
              "maxItems": 20,
              "items": {
                "$ref": "#/components/schemas/NarrowEvaluationCriterion",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "id",
                  "text"
                ],
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^[a-z][a-z0-9_]{0,63}$"
                  },
                  "text": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 1000
                  }
                }
              }
            }
          }
        },
        "allowedOutcomes": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/NarrowEvaluationOutcome",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "code",
              "settlementAction"
            ],
            "properties": {
              "code": {
                "type": "string",
                "pattern": "^[a-z][a-z0-9_]{0,63}$"
              },
              "label": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "settlementAction": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "type"
                ],
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": [
                      "release_to_claimant",
                      "release_to_respondent",
                      "allocate_by_award",
                      "none"
                    ]
                  }
                }
              }
            }
          }
        },
        "evidencePolicy": {
          "$ref": "#/components/schemas/NarrowEvaluationEvidencePolicy",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "sources",
            "additionalPartyEvidence"
          ],
          "properties": {
            "sources": {
              "type": "array",
              "minItems": 1,
              "maxItems": 2,
              "uniqueItems": true,
              "items": {
                "type": "string",
                "enum": [
                  "party_submissions",
                  "evidence_export_candidates"
                ]
              }
            },
            "additionalPartyEvidence": {
              "type": "boolean",
              "const": true
            }
          }
        },
        "reviewPolicy": {
          "$ref": "#/components/schemas/NarrowEvaluationReviewPolicy",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "initialPath",
            "humanReviewRequired"
          ],
          "properties": {
            "initialPath": {
              "type": "string",
              "const": "adjudicative"
            },
            "humanReviewRequired": {
              "type": "boolean",
              "const": false
            }
          }
        },
        "record": {
          "$ref": "#/components/schemas/NarrowEvaluationRecord",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "status"
          ],
          "properties": {
            "phase": {
              "type": "string",
              "enum": [
                "evidence",
                "close",
                "merits"
              ]
            },
            "status": {
              "type": "string",
              "enum": [
                "open",
                "frozen"
              ]
            }
          }
        },
        "result": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/NarrowEvaluationPendingResult",
              "type": "object",
              "additionalProperties": false,
              "required": [
                "status",
                "finality"
              ],
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "pending",
                    "under_review"
                  ]
                },
                "finality": {
                  "type": "string",
                  "const": "not_served"
                }
              }
            },
            {
              "$ref": "#/components/schemas/NarrowEvaluationServedResult",
              "type": "object",
              "additionalProperties": false,
              "required": [
                "status",
                "finality",
                "outcomeCode",
                "settlementAction",
                "criterionFindings",
                "determinations",
                "award"
              ],
              "properties": {
                "status": {
                  "type": "string",
                  "const": "served"
                },
                "finality": {
                  "type": "string",
                  "enum": [
                    "served",
                    "appealable",
                    "appeal_reserved",
                    "appeal_pending",
                    "final"
                  ]
                },
                "outcomeCode": {
                  "type": "string"
                },
                "settlementAction": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "type"
                  ],
                  "properties": {
                    "type": {
                      "type": "string",
                      "enum": [
                        "release_to_claimant",
                        "release_to_respondent",
                        "allocate_by_award",
                        "none"
                      ]
                    }
                  }
                },
                "criterionFindings": {
                  "type": "array",
                  "minItems": 1,
                  "maxItems": 20,
                  "items": {
                    "$ref": "#/components/schemas/NarrowEvaluationCriterionFinding",
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "criterionId",
                      "status",
                      "finding",
                      "confidence"
                    ],
                    "properties": {
                      "criterionId": {
                        "type": "string",
                        "pattern": "^[a-z][a-z0-9_]{0,63}$"
                      },
                      "status": {
                        "type": "string",
                        "enum": [
                          "satisfied",
                          "not_satisfied",
                          "indeterminate"
                        ]
                      },
                      "finding": {
                        "type": "string"
                      },
                      "confidence": {
                        "type": "number",
                        "minimum": 0,
                        "maximum": 1
                      }
                    }
                  }
                },
                "determinations": {
                  "type": "object",
                  "additionalProperties": true
                },
                "award": {
                  "$ref": "#/components/schemas/NarrowEvaluationAwardReference",
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "dispositionId",
                    "awardHash",
                    "resourcePath"
                  ],
                  "properties": {
                    "dispositionId": {
                      "type": "string"
                    },
                    "awardHash": {
                      "type": "string",
                      "pattern": "^[a-f0-9]{64}$"
                    },
                    "releasedAt": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "resourcePath": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          ],
          "discriminator": {
            "propertyName": "status"
          }
        }
      }
    },
    "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"
    },
    "details": {
      "description": "Account-readiness refusals include a value-free checklist and exact account-page link. Other error codes may provide different details.",
      "anyOf": [
        {
          "$ref": "#/components/schemas/AccountReadinessDetails",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "ready",
            "accountSetupUrl",
            "missing"
          ],
          "properties": {
            "ready": {
              "type": "boolean"
            },
            "accountSetupUrl": {
              "type": "string",
              "format": "uri"
            },
            "missing": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AccountReadinessRequirement",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "label",
                  "section",
                  "accountUrl"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "section": {
                    "type": "string",
                    "enum": [
                      "email",
                      "identity",
                      "legal_documents"
                    ]
                  },
                  "accountUrl": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              }
            }
          }
        },
        {
          "$ref": "#/components/schemas/LegalDocumentsRequiredDetails",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "legalDocumentsUrl"
          ],
          "properties": {
            "legalDocumentsUrl": {
              "type": "string",
              "format": "uri",
              "description": "Absolute account-page URL where the person reviews and accepts the current Terms and Privacy Notice. Uses the configured public application origin. After accepting the documents, retry the original operation."
            },
            "ready": {
              "type": "boolean"
            },
            "accountSetupUrl": {
              "type": "string",
              "format": "uri"
            },
            "missing": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AccountReadinessRequirement",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "label",
                  "section",
                  "accountUrl"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "section": {
                    "type": "string",
                    "enum": [
                      "email",
                      "identity",
                      "legal_documents"
                    ]
                  },
                  "accountUrl": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              }
            }
          }
        },
        {}
      ]
    }
  }
}

Example response

Successful response

{
  "data": {
    "schemaVersion": "narrow-evaluation-resource-v2",
    "caseId": "pcase_test_123",
    "externalCaseId": "marketplace_case_123",
    "externalEvaluationId": "externalEvaluationId_test",
    "evaluationDigest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "question": {
      "text": "Test-environment procedural message.",
      "criteria": [
        {
          "id": "id_test",
          "text": "Test-environment procedural message."
        }
      ]
    },
    "allowedOutcomes": [
      {
        "code": "code_test",
        "settlementAction": {
          "type": "release_to_claimant"
        }
      }
    ],
    "evidencePolicy": {
      "sources": [
        "party_submissions"
      ],
      "additionalPartyEvidence": true
    },
    "reviewPolicy": {
      "initialPath": "adjudicative",
      "humanReviewRequired": false
    },
    "record": {
      "status": "open"
    },
    "result": {
      "status": "pending",
      "finality": "not_served"
    }
  },
  "requestId": "requestId_test"
}

Errors

Read the response status and stable error code. See errors and rate limits for recovery. Refresh the resource before resolving a state or digest conflict.

Idempotency and retries

  • For throttling, honor Retry-After when present. Back off on retryable server failures.