Topolo Docs Topolo Platform
Open workspace

Get contract review

Read a source-linked review and reconstruct its retained DOCX text for inspection in the selected workspace.

Read a source-linked review and reconstruct its retained DOCX text for inspection in the selected workspace.

Access

Requires app_topolo_contracts.workspace:read and the intended authenticated organization and workspace. Select the permitted workspace through the supported resource-binding flow; do not add a workspace id to strict action input.

Steps

  1. Discover a review id in the authorized workspace.
  2. Read its current version, coverage, source-linked findings and captured policy.
  3. Use this current version for subsequent decisions; inspect the original source and any redline anchors before accepting a change.

Identifiers

  • Use reviews.list or a completed intake’s reviewId. Findings and paragraph references are scoped to that returned review/document.

Request

GET /api/reviews/{reviewId}

Action: app_topolo_contracts.reviews.get.

  • reviewId: required, string, at least 1 characters, at most 160 characters.

Response and effects

  • Reads/decrypts the review and, when a document exists, reads and parses the retained original to reconstruct current contractText and sourceParagraphs. The private object key is removed from the public document metadata.
  • This read can fail when the protected source is unavailable or missing; a stored review record alone does not establish that the original can be verified.
  • Returned contract content is confidential workspace data. Status ready/approved is not signature or contractual execution.

Examples

Example request and response

Request input:

{
  "reviewId": "11111111-1111-4111-8111-111111111111"
}

Illustrated response:

{
  "review": {
    "id": "11111111-1111-4111-8111-111111111111",
    "title": "Documentation specimen",
    "counterparty": "Example Beta",
    "contractType": "Mutual NDA",
    "owner": "Legal review",
    "route": "review",
    "status": "in_review",
    "submittedAt": "2026-10-21T00:00:00.000Z",
    "dueAt": "Not set",
    "policyPack": "Workspace mutual NDA",
    "policyVersion": "1",
    "policyApproval": {
      "policyId": "default",
      "contractType": "mutual_nda",
      "version": 1,
      "confidentialityYears": 3,
      "governingLaw": "England and Wales",
      "approvedBy": "user_documentation_fixture",
      "approvedAt": "2026-10-21T00:00:00.000Z"
    },
    "version": 1,
    "recommendation": "Human review is required before approval.",
    "coverage": {
      "missingClauses": [
        "Confidentiality period",
        "Governing law"
      ],
      "unverifiedQuotes": 0,
      "sourceInventoryVersion": 1
    },
    "findings": [
      {
        "id": "44444444-4444-4444-8444-444444444444",
        "clause": "Other",
        "severity": "review",
        "summary": "Illustrative human check required.",
        "aiExplanation": "Illustrative human check required.",
        "evidence": "Synthetic documentation specimen for Example Alpha and Example Beta. This main-body paragraph demonstrates source retention and a human review workflow. It forms no agreement, provides no approved legal terms and asserts no actual approval.",
        "policy": "Any unclassified contractual deviation requires human review.",
        "confidence": 0.5,
        "source": "model",
        "paragraph": 0,
        "suggestedText": "Synthetic documentation specimen for Example Alpha and Example Beta. This main-body paragraph demonstrates source retention and a human review workflow. It forms no agreement, provides no approved legal terms and asserts no actual approval. Human check remains required.",
        "resolution": "pending"
      }
    ],
    "sourceParagraphs": [
      {
        "index": 0,
        "text": "Synthetic documentation specimen for Example Alpha and Example Beta. This main-body paragraph demonstrates source retention and a human review workflow. It forms no agreement, provides no approved legal terms and asserts no actual approval.",
        "originalText": "Synthetic documentation specimen for Example Alpha and Example Beta. This main-body paragraph demonstrates source retention and a human review workflow. It forms no agreement, provides no approved legal terms and asserts no actual approval."
      }
    ],
    "document": {
      "filename": "documentation-specimen.docx",
      "sha256": "6ca130ea78e011afbd4384bbe0ee82ea155a8bb65b7cad0f17932c3b402c6174",
      "redlines": []
    },
    "contractText": "[Paragraph 1] Synthetic documentation specimen for Example Alpha and Example Beta. This main-body paragraph demonstrates source retention and a human review workflow. It forms no agreement, provides no approved legal terms and asserts no actual approval."
  }
}

HTTP 200 illustration. Hypothetical authorized operation only; inspect the action-specific fields and boundaries below.

Refusal or dependency failure

If: No review row for this reviewId is visible in the already authorized organization and workspace.

Request input:

{
  "reviewId": "11111111-1111-4111-8111-111111111111"
}

Source error-code excerpt (HTTP 404):

{
  "error": "review_not_found"
}

Discover a review in the selected workspace.

Refusal or dependency failure

If: The action has an otherwise valid authorized context and input, but the source-document storage binding is unavailable. For a review read, the stored review still references a document.

Request input:

{
  "reviewId": "11111111-1111-4111-8111-111111111111"
}

Source error-code excerpt (HTTP 503):

{
  "error": "contracts_documents_unavailable"
}

Restore source storage access before making evidence-dependent decisions.

Verification readback illustration

Request input:

{
  "reviewId": "11111111-1111-4111-8111-111111111111"
}

Illustrated response:

{
  "review": {
    "id": "11111111-1111-4111-8111-111111111111",
    "title": "Documentation specimen",
    "counterparty": "Example Beta",
    "contractType": "Mutual NDA",
    "owner": "Legal review",
    "route": "review",
    "status": "in_review",
    "submittedAt": "2026-10-21T00:00:00.000Z",
    "dueAt": "Not set",
    "policyPack": "Workspace mutual NDA",
    "policyVersion": "1",
    "policyApproval": {
      "policyId": "default",
      "contractType": "mutual_nda",
      "version": 1,
      "confidentialityYears": 3,
      "governingLaw": "England and Wales",
      "approvedBy": "user_documentation_fixture",
      "approvedAt": "2026-10-21T00:00:00.000Z"
    },
    "version": 1,
    "recommendation": "Human review is required before approval.",
    "coverage": {
      "missingClauses": [
        "Confidentiality period",
        "Governing law"
      ],
      "unverifiedQuotes": 0,
      "sourceInventoryVersion": 1
    },
    "findings": [
      {
        "id": "44444444-4444-4444-8444-444444444444",
        "clause": "Other",
        "severity": "review",
        "summary": "Illustrative human check required.",
        "aiExplanation": "Illustrative human check required.",
        "evidence": "Synthetic documentation specimen for Example Alpha and Example Beta. This main-body paragraph demonstrates source retention and a human review workflow. It forms no agreement, provides no approved legal terms and asserts no actual approval.",
        "policy": "Any unclassified contractual deviation requires human review.",
        "confidence": 0.5,
        "source": "model",
        "paragraph": 0,
        "suggestedText": "Synthetic documentation specimen for Example Alpha and Example Beta. This main-body paragraph demonstrates source retention and a human review workflow. It forms no agreement, provides no approved legal terms and asserts no actual approval. Human check remains required.",
        "resolution": "pending"
      }
    ],
    "sourceParagraphs": [
      {
        "index": 0,
        "text": "Synthetic documentation specimen for Example Alpha and Example Beta. This main-body paragraph demonstrates source retention and a human review workflow. It forms no agreement, provides no approved legal terms and asserts no actual approval.",
        "originalText": "Synthetic documentation specimen for Example Alpha and Example Beta. This main-body paragraph demonstrates source retention and a human review workflow. It forms no agreement, provides no approved legal terms and asserts no actual approval."
      }
    ],
    "document": {
      "filename": "documentation-specimen.docx",
      "sha256": "6ca130ea78e011afbd4384bbe0ee82ea155a8bb65b7cad0f17932c3b402c6174",
      "redlines": []
    },
    "contractText": "[Paragraph 1] Synthetic documentation specimen for Example Alpha and Example Beta. This main-body paragraph demonstrates source retention and a human review workflow. It forms no agreement, provides no approved legal terms and asserts no actual approval."
  }
}

HTTP 200 illustration. Illustrative readback only; no request was executed.

Verify the result

  • Compare document sha256, review version, source paragraph/evidence, missing clauses and unverifiedQuotes; do not infer successful provider execution merely from the page existing.

Recovery

  • 404 review_not_found: Discover a review in the selected workspace.
  • 503 contract_document_missing: Reconcile source availability with its custodian; the worker maps missing source to unavailability for this read.
  • 503 contracts_documents_unavailable: Restore source storage access before making evidence-dependent decisions.
  • 401 authentication_required: Outer authentication/authorization contract: Authenticate again with an entitled Contracts credential. Reconcile uncertain earlier write effects before any retry.
  • 403 permission_denied: Outer authentication/authorization contract: Grant workspace:read without changing the organization context. Reconcile uncertain earlier write effects before any retry.
  • 429 rate_limited: Outer authentication/authorization contract: Wait for Retry-After when present, then retry without parallel duplicate calls. Reconcile uncertain earlier write effects before any retry.

Read-only. Preserve the last verified review and unknown source condition; do not accept wording or recreate an upload to hide a missing-source failure.

Source and example limits — 21 October 2026: based on reviewed Contracts source 4bfd49a; current serving association is unverified. All requests, responses, approvals and document specimens shown are fictional and unrun. Offline schema/ZIP/XML checks do not prove application acceptance, legal completeness, provider outcomes or human approval.