GETpartial

Download a v2 party record manifest or full verified bundle

Both forms use the isolated case-record-bundle-v2 identity and exact-money canonical JSON. Manifest responses and full bundles carry a signed v2 attestation binding partner, public case IDs, side, revision, Rules, bundle identity, and every file digest. Verification scans the entire canonical artifact for internal IDs and requires case, docket, messages, applicable decisions, and a validated award-decision-v2 plus matching trusted attestation for every required revision; filenames alone never establish completeness. The opaque sourceSnapshotHash supports deterministic cache identity without exposing any v1 source bundle ID; no recipe-v3 envelope, v1 bundle ID, or v1 cache row is exposed or reused.

/api/cases/{id}/record-bundlegetCaseRecordBundleManifestCanonical

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"}
formatqueryOptional{"type":"string","enum":["manifest","bundle"],"default":"manifest"}
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

Party record integrity manifest envelope or canonical full bundle bytes.

application/json

{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "data": {
          "type": "object",
          "properties": {
            "artifactSha256": {
              "type": "string"
            },
            "byteLength": {
              "type": "integer"
            },
            "verification": {
              "type": "object",
              "properties": {
                "ok": {
                  "const": true
                },
                "mode": {
                  "type": "string",
                  "enum": [
                    "persisted_snapshot_reuse",
                    "verified_at_creation"
                  ]
                },
                "bundleId": {
                  "type": "string"
                },
                "bundleHash": {
                  "type": "string"
                }
              }
            },
            "caseId": {
              "type": "string"
            },
            "externalCaseId": {
              "type": "string"
            },
            "manifest": {
              "$ref": "#/components/schemas/PartnerCaseRecordBundleManifest",
              "type": "object",
              "additionalProperties": false,
              "required": [
                "schemaVersion",
                "recipe",
                "partnerId",
                "caseId",
                "externalCaseId",
                "caseRevision",
                "profile",
                "partySide",
                "sourceSnapshotHash",
                "snapshotAt",
                "rules",
                "files",
                "exclusions",
                "bundleId",
                "bundleHash"
              ],
              "properties": {
                "schemaVersion": {
                  "type": "string",
                  "const": "case-record-bundle-v2"
                },
                "recipe": {
                  "type": "string",
                  "const": "sha256-canonical-json-v2"
                },
                "partnerId": {
                  "type": "string"
                },
                "caseId": {
                  "type": "string"
                },
                "externalCaseId": {
                  "type": "string"
                },
                "caseRevision": {
                  "type": "integer",
                  "minimum": 1
                },
                "dispositionId": {
                  "type": "string"
                },
                "awardRevision": {
                  "type": "integer",
                  "minimum": 1
                },
                "profile": {
                  "type": "string",
                  "const": "party"
                },
                "partySide": {
                  "type": "string",
                  "enum": [
                    "claimant",
                    "respondent"
                  ]
                },
                "sourceSnapshotHash": {
                  "type": "string",
                  "pattern": "^[a-f0-9]{64}$"
                },
                "snapshotAt": {
                  "type": "string",
                  "format": "date-time"
                },
                "rules": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "version": {
                      "type": "string"
                    },
                    "sha256": {
                      "type": "string",
                      "pattern": "^[a-f0-9]{64}$"
                    }
                  }
                },
                "files": {
                  "type": "array",
                  "minItems": 3,
                  "items": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "path",
                      "mediaType",
                      "byteLength",
                      "sha256",
                      "category"
                    ],
                    "properties": {
                      "path": {
                        "type": "string"
                      },
                      "mediaType": {
                        "type": "string"
                      },
                      "byteLength": {
                        "type": "integer",
                        "minimum": 1
                      },
                      "sha256": {
                        "type": "string",
                        "pattern": "^[a-f0-9]{64}$"
                      },
                      "sourceSha256": {
                        "type": "string",
                        "pattern": "^[a-f0-9]{64}$"
                      },
                      "sourceId": {
                        "type": "string"
                      },
                      "category": {
                        "type": "string"
                      }
                    }
                  }
                },
                "exclusions": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "code",
                      "detail"
                    ],
                    "properties": {
                      "code": {
                        "type": "string"
                      },
                      "sourceId": {
                        "type": "string"
                      },
                      "detail": {
                        "type": "string"
                      }
                    }
                  }
                },
                "bundleId": {
                  "type": "string",
                  "pattern": "^crb2_[a-f0-9]{64}$"
                },
                "bundleHash": {
                  "type": "string",
                  "pattern": "^[a-f0-9]{64}$"
                }
              }
            },
            "attestation": {
              "$ref": "#/components/schemas/PartnerCaseRecordBundleAttestation",
              "type": "object",
              "additionalProperties": false,
              "required": [
                "schemaVersion",
                "partnerId",
                "caseId",
                "externalCaseId",
                "partySide",
                "caseRevision",
                "bundleId",
                "bundleHash",
                "rules",
                "files",
                "attestationDigest",
                "signature"
              ],
              "properties": {
                "schemaVersion": {
                  "type": "string",
                  "const": "partner-case-record-bundle-attestation-v2"
                },
                "partnerId": {
                  "type": "string"
                },
                "caseId": {
                  "type": "string"
                },
                "externalCaseId": {
                  "type": "string"
                },
                "partySide": {
                  "type": "string",
                  "enum": [
                    "claimant",
                    "respondent"
                  ]
                },
                "caseRevision": {
                  "type": "integer",
                  "minimum": 1
                },
                "bundleId": {
                  "type": "string",
                  "pattern": "^crb2_[a-f0-9]{64}$"
                },
                "bundleHash": {
                  "type": "string",
                  "pattern": "^[a-f0-9]{64}$"
                },
                "rules": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "version": {
                      "type": "string"
                    },
                    "sha256": {
                      "type": "string",
                      "pattern": "^[a-f0-9]{64}$"
                    }
                  }
                },
                "files": {
                  "type": "array",
                  "minItems": 3,
                  "items": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "path",
                      "mediaType",
                      "byteLength",
                      "sha256"
                    ],
                    "properties": {
                      "path": {
                        "type": "string"
                      },
                      "mediaType": {
                        "type": "string"
                      },
                      "byteLength": {
                        "type": "integer",
                        "minimum": 0
                      },
                      "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",
            "externalCaseId",
            "manifest",
            "attestation",
            "artifactSha256",
            "byteLength",
            "verification"
          ]
        },
        "requestId": {
          "type": "string"
        }
      },
      "required": [
        "data",
        "requestId"
      ]
    },
    {
      "type": "object",
      "properties": {
        "ok": {
          "const": true
        },
        "data": {
          "type": "object",
          "properties": {
            "artifactSha256": {
              "type": "string"
            },
            "byteLength": {
              "type": "integer"
            },
            "verification": {
              "type": "object",
              "properties": {
                "ok": {
                  "const": true
                },
                "mode": {
                  "type": "string",
                  "enum": [
                    "persisted_snapshot_reuse",
                    "verified_at_creation"
                  ]
                },
                "bundleId": {
                  "type": "string"
                },
                "bundleHash": {
                  "type": "string"
                }
              }
            },
            "manifest": {
              "$ref": "#/components/schemas/CanonicalHostedRecordBundleManifest",
              "type": "object",
              "properties": {
                "schemaVersion": {
                  "const": "case-record-bundle-v1"
                },
                "recipe": {
                  "const": "sha256-canonical-json-v1"
                },
                "sourceGraphVersion": {
                  "const": "case-record-source-graph-v1"
                },
                "disputeId": {
                  "type": "string"
                },
                "dispositionId": {
                  "type": "string"
                },
                "caseRevision": {
                  "type": "integer"
                },
                "awardRevision": {
                  "type": "integer"
                },
                "profile": {
                  "type": "string",
                  "enum": [
                    "party",
                    "reviewer",
                    "court"
                  ]
                },
                "partySide": {
                  "type": "string",
                  "enum": [
                    "claimant",
                    "respondent"
                  ]
                },
                "sourceSnapshotHash": {
                  "type": "string"
                },
                "rules": {
                  "type": "object",
                  "properties": {
                    "version": {
                      "type": "string"
                    },
                    "sha256": {
                      "type": "string"
                    }
                  }
                },
                "snapshotAt": {
                  "type": "string"
                },
                "files": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "path": {
                        "type": "string"
                      },
                      "mediaType": {
                        "type": "string"
                      },
                      "byteLength": {
                        "type": "integer"
                      },
                      "sha256": {
                        "type": "string"
                      },
                      "sourceSha256": {
                        "type": "string"
                      },
                      "sourceId": {
                        "type": "string"
                      },
                      "category": {
                        "type": "string"
                      }
                    }
                  }
                },
                "exclusions": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "code": {
                        "type": "string"
                      },
                      "sourceId": {
                        "type": "string"
                      },
                      "detail": {
                        "type": "string"
                      }
                    }
                  }
                },
                "bundleId": {
                  "type": "string"
                },
                "bundleHash": {
                  "type": "string"
                }
              }
            }
          },
          "required": [
            "manifest",
            "artifactSha256",
            "byteLength",
            "verification"
          ]
        }
      },
      "required": [
        "ok",
        "data"
      ]
    }
  ]
}

application/vnd.peoples-court.case-record-bundle-v2+json

{
  "type": "string",
  "format": "binary"
}

application/vnd.peoplescourt.case-record+json

{
  "type": "string",
  "format": "binary"
}
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": {
    "artifactSha256": "artifactSha256_test",
    "byteLength": 1,
    "verification": {},
    "caseId": "pcase_test_123",
    "externalCaseId": "marketplace_case_123",
    "manifest": {
      "schemaVersion": "case-record-bundle-v2",
      "recipe": "sha256-canonical-json-v2",
      "partnerId": "partner_test_123",
      "caseId": "pcase_test_123",
      "externalCaseId": "marketplace_case_123",
      "caseRevision": 1,
      "profile": "party",
      "partySide": "claimant",
      "sourceSnapshotHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "snapshotAt": "2026-08-09T12:00:00.000Z",
      "rules": {},
      "files": [
        {
          "path": "path_test",
          "mediaType": "mediaType_test",
          "byteLength": 1,
          "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
          "category": "category_test"
        },
        {
          "path": "path_test",
          "mediaType": "mediaType_test",
          "byteLength": 1,
          "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
          "category": "category_test"
        },
        {
          "path": "path_test",
          "mediaType": "mediaType_test",
          "byteLength": 1,
          "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
          "category": "category_test"
        }
      ],
      "exclusions": [
        {
          "code": "code_test",
          "detail": "detail_test"
        }
      ],
      "bundleId": "crb2_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "bundleHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    },
    "attestation": {
      "schemaVersion": "partner-case-record-bundle-attestation-v2",
      "partnerId": "partner_test_123",
      "caseId": "pcase_test_123",
      "externalCaseId": "marketplace_case_123",
      "partySide": "claimant",
      "caseRevision": 1,
      "bundleId": "crb2_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "bundleHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "rules": {},
      "files": [
        {
          "path": "path_test",
          "mediaType": "mediaType_test",
          "byteLength": 1,
          "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        },
        {
          "path": "path_test",
          "mediaType": "mediaType_test",
          "byteLength": 1,
          "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        },
        {
          "path": "path_test",
          "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.