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

GETpartial

Read the signed Award companion attestation

Read the signed companion attestation for the served Award’s PDF, DOCX and JSON artifacts. Verify its signature with a trusted signer policy and check the case identity, Award hash, revision, byte lengths and digests. The attestation has a closed schema; undeclared fields fail verification.

/api/cases/{id}/award/artifacts/json/attestationgetAwardJsonAttestationCanonical

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/CanonicalGetAwardJsonAttestationCanonicalResponse",
  "type": "object",
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "caseId": {
          "type": "string"
        },
        "artifactId": {
          "type": "string"
        },
        "attestation": {
          "$ref": "#/components/schemas/PartnerAwardArtifactAttestation",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "schemaVersion",
            "case",
            "artifact",
            "source",
            "attestationDigest",
            "signature"
          ],
          "properties": {
            "schemaVersion": {
              "type": "string",
              "const": "partner-award-artifact-attestation-v2"
            },
            "case": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "caseId",
                "externalCaseId"
              ],
              "properties": {
                "caseId": {
                  "type": "string"
                },
                "externalCaseId": {
                  "type": "string"
                }
              }
            },
            "artifact": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "artifactId",
                "schemaVersion",
                "mediaType",
                "byteLength",
                "sha256"
              ],
              "properties": {
                "artifactId": {
                  "type": "string",
                  "pattern": "^pav2_"
                },
                "schemaVersion": {
                  "type": "string",
                  "const": "award-decision-v2"
                },
                "mediaType": {
                  "type": "string",
                  "const": "application/json"
                },
                "byteLength": {
                  "type": "integer",
                  "minimum": 1
                },
                "sha256": {
                  "type": "string",
                  "pattern": "^[a-f0-9]{64}$"
                }
              }
            },
            "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}$"
                      }
                    }
                  }
                }
              }
            },
            "attestationDigest": {
              "type": "string",
              "pattern": "^[a-f0-9]{64}$"
            },
            "signature": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "signature",
                "signerAddress",
                "algorithm",
                "signedAt",
                "signedHash"
              ],
              "properties": {
                "signature": {
                  "type": "string"
                },
                "signerAddress": {
                  "type": "string",
                  "pattern": "^0x[a-fA-F0-9]{40}$"
                },
                "algorithm": {
                  "type": "string",
                  "const": "eip191"
                },
                "signedAt": {
                  "type": "string",
                  "format": "date-time"
                },
                "signedHash": {
                  "type": "string",
                  "pattern": "^[a-f0-9]{64}$"
                }
              }
            }
          }
        }
      },
      "required": [
        "caseId",
        "artifactId",
        "attestation"
      ]
    },
    "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",
    "artifactId": "artifactId_test",
    "attestation": {
      "schemaVersion": "partner-award-artifact-attestation-v2",
      "case": {
        "caseId": "pcase_test_123",
        "externalCaseId": "marketplace_case_123"
      },
      "artifact": {
        "artifactId": "pav2_0123456789abcdef",
        "schemaVersion": "award-decision-v2",
        "mediaType": "application/json",
        "byteLength": 1,
        "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
      },
      "source": {
        "awardHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "dispositionId": "dispositionId_test",
        "awardRevision": 1,
        "artifactSha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "artifacts": [
          {
            "artifactId": "artifactId_test",
            "kind": "pdf",
            "mediaType": "mediaType_test",
            "byteLength": 1,
            "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
          },
          {
            "artifactId": "artifactId_test",
            "kind": "pdf",
            "mediaType": "mediaType_test",
            "byteLength": 1,
            "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
          },
          {
            "artifactId": "artifactId_test",
            "kind": "pdf",
            "mediaType": "mediaType_test",
            "byteLength": 1,
            "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
          }
        ]
      },
      "attestationDigest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "signature": {
        "signature": "ed25519=:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA==:",
        "signerAddress": "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "algorithm": "eip191",
        "signedAt": "2026-08-09T12:00:00.000Z",
        "signedHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
      }
    }
  },
  "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.