For the complete documentation index, see llms.txt. This page is also available as Markdown.

GETpartial

Read the served Award

Read the served Award and its public decision fields. companionArtifacts provides PDF, DOCX and award-decision-v2 JSON descriptors verified by the signed companion attestation. Verify the case identity, Award hash, revision, artifact byte length and digest before relying on a download. Optional postExecutionSupplements are separately signed decisions beside the Award; executionEffect none grants no payment or clawback authority.

/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"}

Responses

200

Authorized operation result.

application/json

{
  "$ref": "#/components/schemas/CanonicalGetServedAwardCanonicalResponse",
  "type": "object",
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "caseId": {
          "type": "string"
        },
        "caseNumber": {
          "type": "string",
          "pattern": "^PC-\\d{4}-\\d{6,}$"
        },
        "caption": {
          "type": "string",
          "maxLength": 120
        },
        "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"
            },
            "postExecutionSupplements": {
              "type": "array",
              "description": "Append-only signed decisions beside the unchanged source Award; no automatic payment, replacement Award or execution receipt.",
              "items": {
                "$ref": "#/components/schemas/PostExecutionAwardSupplement",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "payload",
                  "canonicalJson",
                  "sha256",
                  "signature"
                ],
                "description": "Portable signed envelope. Preserve canonicalJson verbatim; its UTF-8 SHA-256 must equal sha256 and signature.signedHash, and its parsed value must equal payload. Verify the EIP-191 signature against a separately configured trust policy and validate source and predecessor bindings. Readers must never reformat money or redact signed bytes.",
                "properties": {
                  "payload": {
                    "$ref": "#/components/schemas/PostExecutionSupplementPayload",
                    "description": "Append-only public decision. The immutable source Award, receipts and execution operation identities remain unchanged. Monetary corrections state the corrected obligation, not a second full debt; an incompatible unpaid remainder stays held. Additional monetary components receive no automatic execution authority.",
                    "oneOf": [
                      {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "schemaVersion",
                          "id",
                          "source",
                          "requestId",
                          "issuedAt",
                          "issuer",
                          "executionEffect",
                          "priorSupplementsHash",
                          "decision"
                        ],
                        "properties": {
                          "schemaVersion": {
                            "type": "string",
                            "const": "post-execution-supplement-v1"
                          },
                          "id": {
                            "type": "string"
                          },
                          "source": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "dispositionId",
                              "awardHash",
                              "awardRevision",
                              "procedureTermsHash"
                            ],
                            "properties": {
                              "dispositionId": {
                                "type": "string"
                              },
                              "awardHash": {
                                "type": "string",
                                "pattern": "^[a-f0-9]{64}$"
                              },
                              "awardRevision": {
                                "type": "integer",
                                "minimum": 1
                              },
                              "procedureTermsHash": {
                                "type": "string",
                                "pattern": "^[a-f0-9]{64}$"
                              }
                            }
                          },
                          "requestId": {
                            "type": "string"
                          },
                          "issuedAt": {
                            "type": "string",
                            "format": "date-time"
                          },
                          "issuer": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "kind",
                              "label"
                            ],
                            "properties": {
                              "kind": {
                                "type": "string",
                                "enum": [
                                  "human",
                                  "ai"
                                ],
                                "description": "Reviewer denotes only a bounded nonsubstantive correction of an AI-issued source, not a new human merits decision."
                              },
                              "label": {
                                "type": "string"
                              }
                            }
                          },
                          "executionEffect": {
                            "type": "string",
                            "const": "none"
                          },
                          "priorSupplementsHash": {
                            "type": "string",
                            "pattern": "^[a-f0-9]{64}$",
                            "description": "SHA-256 of the canonical ordered array of all preceding supplement hashes."
                          },
                          "targetSupplement": {
                            "$ref": "#/components/schemas/PostExecutionSupplementTarget"
                          },
                          "decision": {
                            "$ref": "#/components/schemas/PostExecutionSupplementDecision"
                          }
                        }
                      },
                      {
                        "type": "object",
                        "additionalProperties": false,
                        "required": [
                          "schemaVersion",
                          "id",
                          "source",
                          "requestId",
                          "issuedAt",
                          "issuer",
                          "executionEffect",
                          "priorSupplementsHash",
                          "decision"
                        ],
                        "properties": {
                          "schemaVersion": {
                            "type": "string",
                            "const": "post-execution-supplement-v1"
                          },
                          "id": {
                            "type": "string"
                          },
                          "source": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "dispositionId",
                              "awardHash",
                              "awardRevision",
                              "procedureTermsHash"
                            ],
                            "properties": {
                              "dispositionId": {
                                "type": "string"
                              },
                              "awardHash": {
                                "type": "string",
                                "pattern": "^[a-f0-9]{64}$"
                              },
                              "awardRevision": {
                                "type": "integer",
                                "minimum": 1
                              },
                              "procedureTermsHash": {
                                "type": "string",
                                "pattern": "^[a-f0-9]{64}$"
                              }
                            }
                          },
                          "requestId": {
                            "type": "string"
                          },
                          "issuedAt": {
                            "type": "string",
                            "format": "date-time"
                          },
                          "issuer": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "kind",
                              "label"
                            ],
                            "properties": {
                              "kind": {
                                "type": "string",
                                "description": "Reviewer denotes only a bounded nonsubstantive correction of an AI-issued source, not a new human merits decision.",
                                "const": "reviewer"
                              },
                              "label": {
                                "type": "string"
                              }
                            }
                          },
                          "executionEffect": {
                            "type": "string",
                            "const": "none"
                          },
                          "priorSupplementsHash": {
                            "type": "string",
                            "pattern": "^[a-f0-9]{64}$",
                            "description": "SHA-256 of the canonical ordered array of all preceding supplement hashes."
                          },
                          "targetSupplement": {
                            "$ref": "#/components/schemas/PostExecutionSupplementTarget"
                          },
                          "decision": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                              "kind",
                              "correction"
                            ],
                            "properties": {
                              "kind": {
                                "type": "string",
                                "const": "correction"
                              },
                              "correction": {
                                "type": "object",
                                "additionalProperties": false,
                                "required": [
                                  "id",
                                  "at",
                                  "by",
                                  "kind",
                                  "reason",
                                  "before",
                                  "after"
                                ],
                                "properties": {
                                  "id": {
                                    "type": "string"
                                  },
                                  "at": {
                                    "type": "string",
                                    "format": "date-time"
                                  },
                                  "by": {
                                    "type": "string"
                                  },
                                  "kind": {
                                    "type": "string",
                                    "enum": [
                                      "funds",
                                      "opinion_text"
                                    ]
                                  },
                                  "reason": {
                                    "type": "string"
                                  },
                                  "before": {
                                    "$ref": "#/components/schemas/PostExecutionSupplementCorrectionMaterial"
                                  },
                                  "after": {
                                    "$ref": "#/components/schemas/PostExecutionSupplementCorrectionMaterial"
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    ]
                  },
                  "canonicalJson": {
                    "type": "string"
                  },
                  "sha256": {
                    "type": "string",
                    "pattern": "^[a-f0-9]{64}$"
                  },
                  "signature": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "signature",
                      "signerAddress",
                      "algorithm",
                      "signedAt",
                      "signedHash"
                    ],
                    "properties": {
                      "signature": {
                        "type": "string",
                        "pattern": "^0x[0-9a-fA-F]{130}$"
                      },
                      "signerAddress": {
                        "type": "string",
                        "pattern": "^0x[0-9a-fA-F]{40}$"
                      },
                      "algorithm": {
                        "type": "string",
                        "const": "eip191"
                      },
                      "signedAt": {
                        "type": "string",
                        "format": "date-time"
                      },
                      "signedHash": {
                        "type": "string",
                        "pattern": "^[a-f0-9]{64}$"
                      }
                    }
                  }
                }
              }
            },
            "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"
    }
  }
}
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": {
    "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.