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

GETpartial

Download a party record manifest, verified bundle, or readable record

Use format=manifest for the signed file inventory, format=bundle for the complete verified record, or format=readable for inline HTML suitable for printing. The case-record-bundle-v2 attestation binds the public case identity, side, revision, Rules, bundle identity and every file digest. Verify the signature, complete file inventory and all digests. Every required Award revision must include award-decision-v2 and its matching trusted attestation. The readable response uses a Content-Security-Policy that permits its declared print script. GET is a pure read. Prepare explicitly with POST before downloading. HTTP 202 returns data.status=not_prepared and machine-readable data.prepare (method=POST, href) and data.poll (method=GET, href) for a missing current export. Prepared HTTP 200 responses keep their existing shape and remain supported. Migration - internal TypeScript client 0.1.0 from 0601cb31 and earlier only downloads prepared records. Upgrade to 0.2.0 for automatic preparation, implement the authorized POST with an Idempotency-Key before polling GET, or prepare via the case page before using the retained GET. The unreleased 159547e2 draft also used the 0.1.0 package label but included preparation methods. Hosted MCP 0.1.1 preserves the existing manifest tool by preparing internally; deploy it to all replicas before this web change or coordinate both releases. Pre-change MCP 0.1.0 cannot consume the fresh-record 202 response. Implicit preparation by GET is removed with this release. No retirement date for prepared GET retrieval is planned.

/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","readable"],"default":"manifest"}

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"
                  ]
                },
                "recordSchema": {
                  "type": "string",
                  "description": "Schema of the source party record (party-case-record-v1). Opaque to verifiers."
                },
                "metadataSheets": {
                  "type": "string",
                  "description": "The source bundle's exhibit metadata-sheet state (withheld or included). Opaque to verifiers."
                },
                "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": {
                        "$ref": "#/components/schemas/CaseRecordFileCategory"
                      }
                    }
                  }
                },
                "exclusions": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "code",
                      "detail"
                    ],
                    "properties": {
                      "code": {
                        "$ref": "#/components/schemas/CaseRecordExclusionCode"
                      },
                      "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": {
                  "type": "string",
                  "description": "Version of the exported record graph used for verification.",
                  "enum": [
                    "case-record-source-graph-v1",
                    "case-record-source-graph-v2"
                  ]
                },
                "recordSchema": {
                  "type": "string",
                  "description": "Schema of record/case.json. Present on graph v2 bundles.",
                  "enum": [
                    "party-case-record-v1",
                    "court-case-record-v1",
                    "case-record-v1"
                  ]
                },
                "metadataSheets": {
                  "type": "string",
                  "description": "Whether exhibit metadata sheets are in the bundle (graph v2). Presence depends on the recipient’s authorized view.",
                  "enum": [
                    "withheld",
                    "included"
                  ]
                },
                "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"
}

text/html

{
  "type": "string"
}
202

The current record is not prepared. Follow the POST preparation link, then poll GET.

application/json

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/CaseRecordPreparationStatus",
      "type": "object",
      "required": [
        "status",
        "prepare",
        "poll"
      ],
      "additionalProperties": false,
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "not_prepared",
            "ready"
          ]
        },
        "prepare": {
          "type": "object",
          "required": [
            "method",
            "href"
          ],
          "additionalProperties": false,
          "properties": {
            "method": {
              "const": "POST"
            },
            "href": {
              "type": "string"
            }
          }
        },
        "poll": {
          "type": "object",
          "required": [
            "method",
            "href"
          ],
          "additionalProperties": false,
          "properties": {
            "method": {
              "const": "GET"
            },
            "href": {
              "type": "string"
            }
          }
        },
        "bundleId": {
          "type": "string"
        },
        "artifactSha256": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        }
      }
    },
    "ok": {
      "type": "boolean"
    },
    "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": {
    "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": "case"
        },
        {
          "path": "path_test",
          "mediaType": "mediaType_test",
          "byteLength": 1,
          "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
          "category": "case"
        },
        {
          "path": "path_test",
          "mediaType": "mediaType_test",
          "byteLength": 1,
          "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
          "category": "case"
        }
      ],
      "exclusions": [
        {
          "code": "not_disclosed",
          "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.