GETlive

Read the acting side's proposed record restatement

Read the acting side's proposed record restatement Compatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.

/api/v2/cases/{caseId}/restatementgetRestatementV2

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
caseIdpathRequired{"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

Own-side record projection. Inventory cases reuse the hosted source-bound artifact, excluding private preparation custody; historical restatements retain their existing shape.

application/json

{
  "type": "object",
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "requestId": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "schemaVersion": {
          "type": "string",
          "enum": [
            "party-restatement-v2",
            "party-restatement-response-v2"
          ]
        },
        "caseId": {
          "type": "string"
        },
        "party": {
          "type": "string",
          "enum": [
            "claimant",
            "respondent"
          ]
        },
        "preparationVersion": {
          "type": "string",
          "enum": [
            "restatement-v1",
            "restatement-v2",
            "confirmed-request-inventory-v1"
          ],
          "description": "Legacy shared-deadline, historical source-bound, or prospective confirmed request-inventory preparation, respectively."
        },
        "revision": {
          "type": "integer",
          "minimum": 0,
          "description": "Case revision to pass as expectedRevision when confirming this projection."
        },
        "phase": {
          "type": "string"
        },
        "confirmationDueAt": {
          "type": "string",
          "format": "date-time"
        },
        "action": {
          "type": "string",
          "enum": [
            "confirm",
            "correct"
          ]
        },
        "applied": {
          "type": "boolean"
        },
        "restatement": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "text": {
              "type": "string"
            },
            "generatedAt": {
              "type": "string",
              "format": "date-time"
            },
            "status": {
              "type": "string",
              "enum": [
                "pending",
                "confirmed",
                "corrected",
                "lapsed"
              ]
            },
            "respondedAt": {
              "type": "string",
              "format": "date-time"
            },
            "correction": {
              "type": "string"
            },
            "revision": {
              "type": "integer",
              "minimum": 0
            },
            "sourceSubmissionIds": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "sourceContentHashes": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "sourceFingerprint": {
              "type": "string"
            },
            "confirmationDueAt": {
              "type": "string",
              "format": "date-time"
            },
            "rejectedCorrections": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "text": {
                    "type": "string"
                  },
                  "reason": {
                    "type": "string"
                  },
                  "at": {
                    "type": "string",
                    "format": "date-time"
                  }
                }
              }
            },
            "requestInventory": {
              "type": "object",
              "description": "Frozen inventory shared with the hosted party view. Item identities, source bindings, amounts, and digests are returned exactly as recorded. New inventories use version v2 with server-extracted verbatim source spans; existing v1 inventories retain their recorded form.",
              "properties": {
                "version": {
                  "type": "string",
                  "enum": [
                    "confirmed-request-inventory-v1",
                    "confirmed-request-inventory-v2"
                  ]
                },
                "party": {
                  "type": "string",
                  "enum": [
                    "claimant",
                    "respondent"
                  ]
                },
                "sourceFingerprint": {
                  "type": "string"
                },
                "restatementRevision": {
                  "type": "integer",
                  "minimum": 0
                },
                "parents": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "parentId": {
                        "type": "string"
                      },
                      "claimId": {
                        "type": "string"
                      },
                      "title": {
                        "type": "string"
                      },
                      "statement": {
                        "type": "string"
                      },
                      "kind": {
                        "type": "string",
                        "enum": [
                          "monetary",
                          "declaratory",
                          "order"
                        ]
                      },
                      "currency": {
                        "type": "string"
                      }
                    }
                  }
                },
                "items": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "itemId": {
                        "type": "string"
                      },
                      "parentId": {
                        "type": "string"
                      },
                      "parentClaimId": {
                        "type": "string"
                      },
                      "kind": {
                        "type": "string",
                        "enum": [
                          "monetary",
                          "declaratory",
                          "order"
                        ]
                      },
                      "fixedText": {
                        "type": "string"
                      },
                      "requestedAmount": {
                        "type": "number",
                        "description": "Original numeric amount in the frozen inventory artifact; do not replace it with a newly derived money value when confirming."
                      },
                      "currency": {
                        "type": "string"
                      },
                      "canonicalDeclaration": {
                        "type": "string"
                      },
                      "canonicalOrder": {
                        "type": "string"
                      },
                      "residual": {
                        "type": "boolean",
                        "const": true
                      },
                      "source": {
                        "type": "object",
                        "properties": {
                          "sourceId": {
                            "type": "string"
                          },
                          "sourceContentHash": {
                            "type": "string"
                          },
                          "firstLine": {
                            "type": "integer"
                          },
                          "lastLine": {
                            "type": "integer"
                          },
                          "startSegment": {
                            "type": "integer",
                            "minimum": 1,
                            "description": "Inclusive one-based segment within a single source line, present for sub-line selections."
                          },
                          "endSegment": {
                            "type": "integer",
                            "minimum": 1,
                            "description": "Inclusive final segment within the same source line."
                          },
                          "exactText": {
                            "type": "string"
                          }
                        }
                      },
                      "severableScopes": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "scopeId": {
                              "type": "string"
                            },
                            "fixedText": {
                              "type": "string"
                            },
                            "source": {
                              "$ref": "#/paths/~1api~1v2~1cases~1{caseId}~1restatement/get/responses/200/content/application~1json/schema/properties/data/properties/restatement/properties/requestInventory/properties/items/items/properties/source"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "originalParentCoverage": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "displayText": {
                  "type": "string"
                },
                "displayDigest": {
                  "type": "string",
                  "pattern": "^[a-f0-9]{64}$",
                  "description": "Exact confirmation digest; send unchanged as recordDigest or inventoryDigest. Do not re-derive it from prose."
                },
                "inventoryHash": {
                  "type": "string"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "pending",
                    "confirmed",
                    "corrected",
                    "lapsed"
                  ]
                },
                "respondedAt": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            },
            "priorRevisions": {
              "type": "array",
              "items": {
                "$ref": "#/paths/~1api~1v2~1cases~1{caseId}~1restatement/get/responses/200/content/application~1json/schema/properties/data/properties/restatement",
                "type": [
                  "object",
                  "null"
                ],
                "properties": {
                  "text": {
                    "type": "string"
                  },
                  "generatedAt": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "status": {
                    "type": "string",
                    "enum": [
                      "pending",
                      "confirmed",
                      "corrected",
                      "lapsed"
                    ]
                  },
                  "respondedAt": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "correction": {
                    "type": "string"
                  },
                  "revision": {
                    "type": "integer",
                    "minimum": 0
                  },
                  "sourceSubmissionIds": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "sourceContentHashes": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "sourceFingerprint": {
                    "type": "string"
                  },
                  "confirmationDueAt": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "rejectedCorrections": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "text": {
                          "type": "string"
                        },
                        "reason": {
                          "type": "string"
                        },
                        "at": {
                          "type": "string",
                          "format": "date-time"
                        }
                      }
                    }
                  },
                  "requestInventory": {
                    "type": "object",
                    "description": "Frozen inventory shared with the hosted party view. Item identities, source bindings, amounts, and digests are returned exactly as recorded. New inventories use version v2 with server-extracted verbatim source spans; existing v1 inventories retain their recorded form.",
                    "properties": {
                      "version": {
                        "type": "string",
                        "enum": [
                          "confirmed-request-inventory-v1",
                          "confirmed-request-inventory-v2"
                        ]
                      },
                      "party": {
                        "type": "string",
                        "enum": [
                          "claimant",
                          "respondent"
                        ]
                      },
                      "sourceFingerprint": {
                        "type": "string"
                      },
                      "restatementRevision": {
                        "type": "integer",
                        "minimum": 0
                      },
                      "parents": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "parentId": {
                              "type": "string"
                            },
                            "claimId": {
                              "type": "string"
                            },
                            "title": {
                              "type": "string"
                            },
                            "statement": {
                              "type": "string"
                            },
                            "kind": {
                              "type": "string",
                              "enum": [
                                "monetary",
                                "declaratory",
                                "order"
                              ]
                            },
                            "currency": {
                              "type": "string"
                            }
                          }
                        }
                      },
                      "items": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "itemId": {
                              "type": "string"
                            },
                            "parentId": {
                              "type": "string"
                            },
                            "parentClaimId": {
                              "type": "string"
                            },
                            "kind": {
                              "type": "string",
                              "enum": [
                                "monetary",
                                "declaratory",
                                "order"
                              ]
                            },
                            "fixedText": {
                              "type": "string"
                            },
                            "requestedAmount": {
                              "type": "number",
                              "description": "Original numeric amount in the frozen inventory artifact; do not replace it with a newly derived money value when confirming."
                            },
                            "currency": {
                              "type": "string"
                            },
                            "canonicalDeclaration": {
                              "type": "string"
                            },
                            "canonicalOrder": {
                              "type": "string"
                            },
                            "residual": {
                              "type": "boolean",
                              "const": true
                            },
                            "source": {
                              "type": "object",
                              "properties": {
                                "sourceId": {
                                  "type": "string"
                                },
                                "sourceContentHash": {
                                  "type": "string"
                                },
                                "firstLine": {
                                  "type": "integer"
                                },
                                "lastLine": {
                                  "type": "integer"
                                },
                                "startSegment": {
                                  "type": "integer",
                                  "minimum": 1,
                                  "description": "Inclusive one-based segment within a single source line, present for sub-line selections."
                                },
                                "endSegment": {
                                  "type": "integer",
                                  "minimum": 1,
                                  "description": "Inclusive final segment within the same source line."
                                },
                                "exactText": {
                                  "type": "string"
                                }
                              }
                            },
                            "severableScopes": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "scopeId": {
                                    "type": "string"
                                  },
                                  "fixedText": {
                                    "type": "string"
                                  },
                                  "source": {
                                    "$ref": "#/paths/~1api~1v2~1cases~1{caseId}~1restatement/get/responses/200/content/application~1json/schema/properties/data/properties/restatement/properties/requestInventory/properties/items/items/properties/source"
                                  }
                                }
                              }
                            }
                          }
                        }
                      },
                      "originalParentCoverage": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "displayText": {
                        "type": "string"
                      },
                      "displayDigest": {
                        "type": "string",
                        "pattern": "^[a-f0-9]{64}$",
                        "description": "Exact confirmation digest; send unchanged as recordDigest or inventoryDigest. Do not re-derive it from prose."
                      },
                      "inventoryHash": {
                        "type": "string"
                      },
                      "status": {
                        "type": "string",
                        "enum": [
                          "pending",
                          "confirmed",
                          "corrected",
                          "lapsed"
                        ]
                      },
                      "respondedAt": {
                        "type": "string",
                        "format": "date-time"
                      }
                    }
                  },
                  "priorRevisions": {
                    "type": "array",
                    "items": {
                      "$ref": "#/paths/~1api~1v2~1cases~1{caseId}~1restatement/get/responses/200/content/application~1json/schema/properties/data/properties/restatement"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
403

The caller lacks party role or case proof, the requested side does not match the credential (party_mismatch), or an active membership lacks the required operation grant (case_operation_forbidden). Reads require case:read; record-confirmations POST requires record:confirm; restatement POST requires restatement:respond. Grants are checked before replay and mutation, including when a party token is supplied. Legacy owner cases without memberships retain party-token access.

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"
                  }
                }
              }
            }
          }
        },
        {}
      ]
    }
  }
}
409

Record confirmation refused without committing: record_confirmation_mismatch (digest or statement mismatch), record_confirmation_not_ready (current source-bound artifact unavailable), record_confirmation_resolved (already resolved), record_confirmation_expired (deadline passed), restatement_not_open (review stage unavailable), or case_changed (stale revision or concurrent update). The restatement route uses restatement_not_ready for an unavailable artifact and restatement_already_resolved for a resolved artifact. Inventory corrections through restatement POST return record_inventory_correction_hosted_only; use the hosted correction flow. Historical restatement errors remain unchanged.

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"
                  }
                }
              }
            }
          }
        },
        {}
      ]
    }
  }
}
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

{
  "requestId": "requestId_test",
  "data": {}
}

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.