GETpartial

Read the served Award

Returns the deterministic public decision projection derived from the immutable signed award-decision-v2 revision, never a mutable live disposition. It contains no internal dispute ID and no recipe-v3 manifest or verification envelope. Known internal IDs are replaced even when embedded in strings; every recognized money key must be numeric internally, null, or exact FiatMoney, every present amounts field must be an exact-money array, and malformed values or residual internal-ID patterns fail closed. companionArtifacts advertises PDF, DOCX, and canonical award-decision-v2 JSON descriptors through a closed-schema, separately signed, public-case-bound companion attestation.

/api/cases/{id}/awardgetServedAwardCanonical

Authentication and authority

Send one of the allowed bearer credential roles. Alternatives are OR; credentials named within one alternative are AND.

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
idpathRequired{"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"}
x-pc-compatibility

Bounded compatibility inputs on the canonical URL. Existing scoped credentials retain v1 responses; role-bound credentials use grant-checked typed operations. Preserves each contract’s original journals, consent and disclosure. See /openapi/partner-v1.json for scoped credentials.

headerOptional{"type":"string","enum":["v1"]}

Responses

200

Authorized operation result.

application/json

{
  "$ref": "#/components/schemas/CanonicalGetServedAwardCanonicalResponse",
  "type": "object",
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "caseId": {
          "type": "string"
        },
        "externalCaseId": {
          "type": "string"
        },
        "award": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "awardHash": {
              "type": "string"
            },
            "awardHashVersion": {
              "type": "integer"
            },
            "awardRevision": {
              "type": "integer"
            },
            "rulesVersion": {
              "type": "string"
            },
            "dispositionLabel": {
              "type": "string"
            },
            "posture": {
              "type": "string"
            },
            "releasedToParties": {
              "type": "boolean"
            },
            "releasedAt": {
              "type": "string"
            },
            "companionArtifacts": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "artifactId": {
                    "type": "string"
                  },
                  "kind": {
                    "type": "string"
                  },
                  "schemaVersion": {
                    "type": "string"
                  },
                  "mediaType": {
                    "type": "string"
                  },
                  "byteLength": {
                    "type": "integer"
                  },
                  "sha256": {
                    "type": "string"
                  },
                  "downloadPath": {
                    "type": "string"
                  },
                  "attestationPath": {
                    "type": "string"
                  },
                  "attestationDigest": {
                    "type": "string"
                  },
                  "source": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "awardHash",
                      "dispositionId",
                      "awardRevision",
                      "artifactSha256",
                      "artifacts"
                    ],
                    "properties": {
                      "awardHash": {
                        "type": "string",
                        "pattern": "^[a-f0-9]{64}$"
                      },
                      "dispositionId": {
                        "type": "string"
                      },
                      "awardRevision": {
                        "type": "integer",
                        "minimum": 1
                      },
                      "artifactSha256": {
                        "type": "string",
                        "pattern": "^[a-f0-9]{64}$"
                      },
                      "artifacts": {
                        "type": "array",
                        "description": "Exactly one descriptor for each frozen source kind: pdf, docx, and json.",
                        "minItems": 3,
                        "maxItems": 3,
                        "items": {
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "artifactId",
                            "kind",
                            "mediaType",
                            "byteLength",
                            "sha256"
                          ],
                          "properties": {
                            "artifactId": {
                              "type": "string"
                            },
                            "kind": {
                              "type": "string",
                              "enum": [
                                "pdf",
                                "docx",
                                "json"
                              ]
                            },
                            "mediaType": {
                              "type": "string"
                            },
                            "byteLength": {
                              "type": "integer",
                              "minimum": 1
                            },
                            "sha256": {
                              "type": "string",
                              "pattern": "^[a-f0-9]{64}$"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "required": [
            "id",
            "awardHash",
            "awardHashVersion",
            "awardRevision",
            "companionArtifacts"
          ]
        }
      },
      "required": [
        "caseId",
        "externalCaseId",
        "award"
      ]
    },
    "requestId": {
      "type": "string"
    }
  },
  "x-code-source": "lib/api/award-award-representation.ts"
}
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": {
    "caseId": "pcase_test_123",
    "externalCaseId": "marketplace_case_123",
    "award": {
      "id": "id_test",
      "awardHash": "awardHash_test",
      "awardHashVersion": 1,
      "awardRevision": 1,
      "companionArtifacts": [
        {}
      ]
    }
  },
  "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.