Reviews

Endpoints for creating, listing, and retrieving contract reviews for the current organization.

Retrieve a review

GET

https://api.gerri.commonpaper.com

/v1/organizations/{organization_id}/reviews/{id}

Shows one review for the current organization (by id). Includes nested redline_evaluations, summary_positions, and flag_violations when applicable—the paginated GET /v1/organizations/{organization_id}/reviews index omits those for each item.

Retrieve a review › path Parameters

organization_id

string · uuid · required

Organization id

id

string · uuid · required

Review id

Retrieve a review › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Retrieve a review › Responses

A single review

ReviewResponse

ReviewResource · required

GET/v1/organizations/{organization_id}/reviews/{id}

curl https://api.gerri.commonpaper.com/v1/organizations/:organization_id/reviews/:id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": {
    "id": "1f31507c-d004-42fc-aa75-6f51b95c2cba",
    "type": "review",
    "attributes": {
      "id": "1f31507c-d004-42fc-aa75-6f51b95c2cba",
      "completed_at": "2026-04-10T17:13:33.564Z",
      "status": "completed",
      "imported_file_id": "7302ca88-b6a4-4eda-80b1-c4baaf845636",
      "name": "Cloud Services Agreement with Vandelay Industries",
      "updated_at": "2026-04-10T19:25:53.638Z",
      "created_at": "2026-04-10T17:13:04.739Z",
      "review_type": "RedlineReview",
      "playbook_id": "4a6b0b49-8d54-4d95-a8ab-decddd499164",
      "redline_evaluations": [
        {
          "data": {
            "id": "02009a99-8160-4102-9bc9-505c148afbf6",
            "type": "redline_evaluation",
            "attributes": {
              "commentary": "This change adds several new situations where the customer's liability could be uncapped. Recommend capping liability or carving out exceptions.",
              "rejection_comment": null,
              "relevant_rule_topics": [],
              "created_at": "2026-04-10T17:13:05.990Z",
              "updated_at": "2026-04-10T17:13:21.390Z",
              "gerri_evaluation": "needs_review",
              "current_evaluation": "needs_review",
              "current_comment": null
            }
          }
        },
        {
          "data": {
            "id": "158e7799-7e53-4ca2-87b5-1fe5ee0d1d98",
            "type": "redline_evaluation",
            "attributes": {
              "commentary": "This change says the provider can only use the customer's logo in pre-approved marketing. That aligns with the playbook guidance.",
              "rejection_comment": null,
              "relevant_rule_topics": [],
              "created_at": "2026-04-10T17:13:06.000Z",
              "updated_at": "2026-04-10T17:13:16.005Z",
              "gerri_evaluation": "accept",
              "current_evaluation": "accept",
              "current_comment": null
            }
          }
        }
      ]
    }
  }
}

json

application/json

Retrieve all reviews

GET

https://api.gerri.commonpaper.com

/v1/organizations/{organization_id}/reviews

Lists reviews for the current organization with pagination (page[number]). The default page size is 30 reviews per page.

Each list item includes core review fields, name (imported file name), and review_type. redline_evaluations, summary_positions (per-topic summaries), and flag_violations are not included here; they appear on GET /v1/organizations/{organization_id}/reviews/{id} (and on the dedicated nested collection endpoints where applicable).

Retrieve all reviews › path Parameters

organization_id

string · uuid · required

Organization id

Retrieve all reviews › query Parameters

page[number]

integer · min: 1

Page number for the review list (defaults to 1 when omitted). Each page returns up to 30 reviews by default.

Retrieve all reviews › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Retrieve all reviews › Responses

200

A paginated list of reviews for the organization (data, meta.pagination, and links are siblings).

ReviewsListResponse

ReviewResourceList[] · required

ReviewsListMeta · required

ReviewsListLinks · required

GET/v1/organizations/{organization_id}/reviews

curl https://api.gerri.commonpaper.com/v1/organizations/:organization_id/reviews \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": "1f31507c-d004-42fc-aa75-6f51b95c2cba",
      "type": "review",
      "attributes": {
        "id": "1f31507c-d004-42fc-aa75-6f51b95c2cba",
        "completed_at": "2026-04-10T17:13:33.564Z",
        "status": "completed",
        "imported_file_id": "7302ca88-b6a4-4eda-80b1-c4baaf845636",
        "name": "Cloud Services Agreement with Vandelay Industries",
        "updated_at": "2026-04-10T19:25:53.638Z",
        "created_at": "2026-04-10T17:13:04.739Z",
        "review_type": "RedlineReview",
        "playbook_id": "4a6b0b49-8d54-4d95-a8ab-decddd499164"
      }
    },
    {
      "id": "da680a00-f733-45c6-a229-8f6a426794f9",
      "type": "review",
      "attributes": {
        "id": "da680a00-f733-45c6-a229-8f6a426794f9",
        "completed_at": "2026-04-09T14:00:00.000Z",
        "status": "completed",
        "imported_file_id": "da8517df-07a4-495c-9251-c57620d4c6a4",
        "name": "NDA with Vandelay Industries",
        "updated_at": "2026-04-09T13:56:06.008Z",
        "created_at": "2026-04-09T13:55:10.200Z",
        "review_type": "SummaryReview",
        "playbook_id": "f8204c23-56be-456f-98e2-2c7f8de419cd"
      }
    }
  ],
  "meta": {
    "pagination": {
      "current": 1,
      "next": 2,
      "last": 5,
      "records": 150
    }
  },
  "links": {
    "self": "https://gerri.commonpaper.com/api/v1/organizations/{organization_id}/reviews",
    "current": "https://gerri.commonpaper.com/api/v1/organizations/{organization_id}/reviews?page[number]=1",
    "next": "https://gerri.commonpaper.com/api/v1/organizations/{organization_id}/reviews?page[number]=2",
    "last": "https://gerri.commonpaper.com/api/v1/organizations/{organization_id}/reviews?page[number]=5"
  }
}

json

application/json

Create a review

POST

https://api.gerri.commonpaper.com

/v1/organizations/{organization_id}/reviews

Start a new review in one of two ways: point at an import you already uploaded with a small application/json body (imported_file_id, optional playbook_id, optional review_type), or upload the contract directly with multipart/form-data using a file part (playbook_id and review_type optional there too). review_type must be RedlineReview or SummaryReview when you send it. Don't send imported_file_id on multipart—that path is only for new files. A 201 response uses the same JSON:API review resource as GET /v1/organizations/{organization_id}/reviews/{id} (full attributes, including nested evaluations or summary data when present); the create call itself is just flat JSON or multipart, not a JSON:API request document.

Create a review › path Parameters

organization_id

string · uuid · required

Organization id

Create a review › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Create a review › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: imported_file_id
	type = object · requires: file

Properties for Existing import (Content-Type: application/json):

Flat JSON: `imported_file_id` (required), optional `playbook_id`, optional `review_type` (`RedlineReview` | `SummaryReview`). See **`#/components/schemas/CreateReviewJsonBody`**.

CreateReviewJsonBody

imported_file_id

string · uuid · minLength: 1 · pattern: ^[0-9a-fA-F]{8}-[0-9… · required

playbook_id

string · uuid · minLength: 1 · pattern: ^[0-9a-fA-F]{8}-[0-9…

review_type

string · enum

Optional; when omitted the service chooses the review mode.

Enum values:

RedlineReview

SummaryReview

Create a review › Responses

Review created; returns the new review resource

ReviewResponse

ReviewResource · required

POST/v1/organizations/{organization_id}/reviews

curl https://api.gerri.commonpaper.com/v1/organizations/:organization_id/reviews \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "imported_file_id": "7302ca88-b6a4-4eda-80b1-c4baaf845636",
  "playbook_id": "4a6b0b49-8d54-4d95-a8ab-decddd499164",
  "review_type": "RedlineReview"
}'

Example Request Body

{
  "imported_file_id": "7302ca88-b6a4-4eda-80b1-c4baaf845636",
  "playbook_id": "4a6b0b49-8d54-4d95-a8ab-decddd499164",
  "review_type": "RedlineReview"
}

json

Example Responses

{
  "data": {
    "id": "1f31507c-d004-42fc-aa75-6f51b95c2cba",
    "type": "review",
    "attributes": {
      "id": "1f31507c-d004-42fc-aa75-6f51b95c2cba",
      "completed_at": null,
      "status": "in_progress",
      "imported_file_id": "7302ca88-b6a4-4eda-80b1-c4baaf845636",
      "name": "Cloud Services Agreement with Vandelay Industries",
      "updated_at": "2026-04-10T17:13:04.739Z",
      "created_at": "2026-04-10T17:13:04.739Z",
      "review_type": "RedlineReview",
      "playbook_id": "4a6b0b49-8d54-4d95-a8ab-decddd499164",
      "redline_evaluations": []
    }
  }
}

json

application/json

List redline evaluations for a review

GET

https://api.gerri.commonpaper.com

/v1/organizations/{organization_id}/reviews/{review_id}/redline_evaluations

Returns every redline evaluation for the given review, scoped to the current organization. This applies to redline reviews (review_type: RedlineReview); the list matches the redline_evaluations array on the review resource from GET /v1/organizations/{organization_id}/reviews/{id}.

List redline evaluations for a review › path Parameters

organization_id

string · uuid · required

Organization id

review_id

string · uuid · required

Review id (must be a redline review to contain evaluations)

List redline evaluations for a review › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List redline evaluations for a review › Responses

Evaluations for the review (may be an empty array while processing or if none apply)

RedlineEvaluationsListResponse

RedlineEvaluation[] · required

Redline evaluations for the review (same objects as attributes.redline_evaluations on a RedlineReview resource).

GET/v1/organizations/{organization_id}/reviews/{review_id}/redline_evaluations

curl https://api.gerri.commonpaper.com/v1/organizations/:organization_id/reviews/:review_id/redline_evaluations \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "data": {
        "id": "02009a99-8160-4102-9bc9-505c148afbf6",
        "type": "redline_evaluation",
        "attributes": {
          "commentary": "This change adds several new situations where the customer's liability could be uncapped. Recommend capping liability or carving out exceptions.",
          "rejection_comment": null,
          "relevant_rule_topics": [],
          "created_at": "2026-04-10T17:13:05.990Z",
          "updated_at": "2026-04-10T17:13:21.390Z",
          "gerri_evaluation": "needs_review",
          "current_evaluation": "needs_review",
          "current_comment": null
        }
      }
    },
    {
      "data": {
        "id": "158e7799-7e53-4ca2-87b5-1fe5ee0d1d98",
        "type": "redline_evaluation",
        "attributes": {
          "commentary": "This change says the provider can only use the customer's logo in pre-approved marketing. That aligns with the playbook guidance.",
          "rejection_comment": null,
          "relevant_rule_topics": [],
          "created_at": "2026-04-10T17:13:06.000Z",
          "updated_at": "2026-04-10T17:13:16.005Z",
          "gerri_evaluation": "accept",
          "current_evaluation": "accept",
          "current_comment": null
        }
      }
    }
  ]
}

json

application/json

Retrieve a single redline evaluation

GET

https://api.gerri.commonpaper.com

/v1/organizations/{organization_id}/reviews/{review_id}/redline_evaluations/{evaluation_id}

Returns one redline evaluation by id under the given review, scoped to the current organization. The payload matches a single element of redline_evaluations on GET /v1/organizations/{organization_id}/reviews/{id}. When a counterproposal exists, attributes.counterproposal is included as a JSON:API-style object with nested data (type counterproposal, id, attributes including directive, suggested_counterproposal_text, created_at, updated_at, and status). Nested attributes.status is always completed or in_progress. When there is no counterproposal, the counterproposal key is omitted from attributes (never null).

Retrieve a single redline evaluation › path Parameters

organization_id

string · uuid · required

Organization id

review_id

string · uuid · required

Parent review id

evaluation_id

string · uuid · required

Redline evaluation id

Retrieve a single redline evaluation › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Retrieve a single redline evaluation › Responses

The requested redline evaluation

RedlineEvaluationResponse

RedlineEvaluation · required

GET/v1/organizations/{organization_id}/reviews/{review_id}/redline_evaluations/{evaluation_id}

curl https://api.gerri.commonpaper.com/v1/organizations/:organization_id/reviews/:review_id/redline_evaluations/:evaluation_id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": {
    "id": "02009a99-8160-4102-9bc9-505c148afbf6",
    "type": "redline_evaluation",
    "attributes": {
      "commentary": "This change adds several new situations where the customer's liability could be uncapped. Recommend capping liability or carving out exceptions.",
      "rejection_comment": null,
      "relevant_rule_topics": [],
      "created_at": "2026-04-10T17:13:05.990Z",
      "updated_at": "2026-04-10T17:13:21.390Z",
      "gerri_evaluation": "needs_review",
      "current_evaluation": "needs_review",
      "current_comment": null
    }
  }
}

json

application/json

Update a redline evaluation

PATCH

https://api.gerri.commonpaper.com

/v1/organizations/{organization_id}/reviews/{review_id}/redline_evaluations/{evaluation_id}

Updates how a single redline evaluation is classified. Send a required evaluation object (discriminated by type) and an optional top-level comment. Simple outcomes are accept, reject, manual, and needs_review (each is only type). counterpropose adds a required counterproposal: either an object { directive } (instruction text) or { new_text } (replacement copy)—exactly one of those two shapes. Applies only to the evaluation identified by evaluation_id under the given review.

Update a redline evaluation › path Parameters

organization_id

string · uuid · required

Organization id

review_id

string · uuid · required

Parent review id

evaluation_id

string · uuid · required

Redline evaluation id

Update a redline evaluation › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update a redline evaluation › Request Body

PatchRedlineEvaluationBody

required

Outcome and payload for this redline evaluation. Discriminated by type; see oneOf variants below.

comment

string

Optional comment accompanying the evaluation update.

Update a redline evaluation › Responses

Updated redline evaluation (same JSON:API data shape as GET). When a counterproposal exists, attributes.counterproposal is a nested JSON:API document { "data": { "id", "type": "counterproposal", "attributes": { … } } }; nested attributes.status is completed or in_progress. Otherwise the counterproposal key is omitted (see GET examples).

RedlineEvaluationResponse

RedlineEvaluation · required

PATCH/v1/organizations/{organization_id}/reviews/{review_id}/redline_evaluations/{evaluation_id}

curl https://api.gerri.commonpaper.com/v1/organizations/:organization_id/reviews/:review_id/redline_evaluations/:evaluation_id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "comment": "Aligned with playbook; no further changes needed.",
  "evaluation": {
    "type": "accept"
  }
}'

Example Request Body

{
  "comment": "Aligned with playbook; no further changes needed.",
  "evaluation": {
    "type": "accept"
  }
}

json

Only `type` is required on the nested `evaluation` object.

application/json

Example Responses

{
  "data": {
    "id": "158e7799-7e53-4ca2-87b5-1fe5ee0d1d98",
    "type": "redline_evaluation",
    "attributes": {
      "commentary": "This change says the provider can only use the customer's logo in pre-approved marketing. That aligns with the playbook guidance.",
      "rejection_comment": null,
      "relevant_rule_topics": [],
      "created_at": "2026-04-10T17:13:06.000Z",
      "updated_at": "2026-04-10T17:25:00.000Z",
      "gerri_evaluation": "accept",
      "current_evaluation": "accept",
      "current_comment": null
    }
  }
}

json

application/json

List flag violations for a review

GET

https://api.gerri.commonpaper.com

/v1/organizations/{organization_id}/reviews/{review_id}/flag_violations

Returns every summary-review flag violation for the given review, scoped to the current organization. This applies to summary reviews (review_type: SummaryReview); the list matches the flag_violations array on the review resource from GET /v1/organizations/{organization_id}/reviews/{id}.

List flag violations for a review › path Parameters

organization_id

string · uuid · required

Organization id

review_id

string · uuid · required

Review id (must be a summary review to contain flag violations)

List flag violations for a review › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List flag violations for a review › Responses

Flag violations for the review (may be an empty array if none were detected)

FlagViolationsListResponse

SummaryReviewFlagViolation[] · required

Flag violations for the review (same objects as attributes.flag_violations on a SummaryReview resource).

GET/v1/organizations/{organization_id}/reviews/{review_id}/flag_violations

curl https://api.gerri.commonpaper.com/v1/organizations/:organization_id/reviews/:review_id/flag_violations \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": "844e07bd-94fe-4bfa-8c9e-c5ea0715f302",
      "decision": "issue_confirmed",
      "created_at": "2026-04-09T13:55:40.375Z",
      "document_references": [
        "Section Auto-renewal — non-renewal notice",
        "Section 5.1 — automatic renewal"
      ],
      "reasoning": "The playbook expects a clear notice window before renewal; the draft leaves the notice period blank.",
      "remedy_suggested": "Insert a non-renewal notice period of at least fifteen (15) days before the renewal date.",
      "reviewer": "test@commonpaper.com",
      "rule": "Automatic renewal must include a defined notice period for opting out.",
      "summary_review_flag_id": "9666a274-2ea8-4a8c-bf39-b02491b15679",
      "summary_review_id": "70e694f3-fe85-4857-a78f-5a05c84feaf4",
      "updated_at": "2026-04-09T13:55:40.375Z"
    }
  ]
}

json

application/json

Retrieve a single flag violation

GET

https://api.gerri.commonpaper.com

/v1/organizations/{organization_id}/reviews/{review_id}/flag_violations/{flag_violation_id}

Returns one flag violation by id under the given review, scoped to the current organization. The payload matches a single element of flag_violations on GET /v1/organizations/{organization_id}/reviews/{id}.

Retrieve a single flag violation › path Parameters

organization_id

string · uuid · required

Organization id

review_id

string · uuid · required

Parent review id

flag_violation_id

string · uuid · required

Flag violation id

Retrieve a single flag violation › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Retrieve a single flag violation › Responses

The requested flag violation

FlagViolationResponse

SummaryReviewFlagViolation · required

GET/v1/organizations/{organization_id}/reviews/{review_id}/flag_violations/{flag_violation_id}

curl https://api.gerri.commonpaper.com/v1/organizations/:organization_id/reviews/:review_id/flag_violations/:flag_violation_id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": {
    "id": "844e07bd-94fe-4bfa-8c9e-c5ea0715f302",
    "decision": "issue_confirmed",
    "created_at": "2026-04-09T13:55:40.375Z",
    "document_references": [
      "Section Auto-renewal — non-renewal notice",
      "Section 5.1 — automatic renewal"
    ],
    "reasoning": "The playbook expects a clear notice window before renewal; the draft leaves the notice period blank.",
    "remedy_suggested": "Insert a non-renewal notice period of at least fifteen (15) days before the renewal date.",
    "reviewer": "test@commonpaper.com",
    "rule": "Automatic renewal must include a defined notice period for opting out.",
    "summary_review_flag_id": "9666a274-2ea8-4a8c-bf39-b02491b15679",
    "summary_review_id": "70e694f3-fe85-4857-a78f-5a05c84feaf4",
    "updated_at": "2026-04-09T13:55:40.375Z"
  }
}

json

application/json

Update a flag violation

PATCH

https://api.gerri.commonpaper.com

/v1/organizations/{organization_id}/reviews/{review_id}/flag_violations/{flag_violation_id}

Records a user decision for a single flag violation: either exception_approved (the exception is accepted) or issue_confirmed (the issue stands). Applies only to the violation identified by flag_violation_id under the given review.

Update a flag violation › path Parameters

organization_id

string · uuid · required

Organization id

review_id

string · uuid · required

Parent review id

flag_violation_id

string · uuid · required

Flag violation id

Update a flag violation › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update a flag violation › Request Body

PatchFlagViolationBody

decision

string · enum · required

User decision for this flag violation.

Enum values:

exception_approved

issue_confirmed

Update a flag violation › Responses

Updated flag violation

FlagViolationResponse

SummaryReviewFlagViolation · required

PATCH/v1/organizations/{organization_id}/reviews/{review_id}/flag_violations/{flag_violation_id}

curl https://api.gerri.commonpaper.com/v1/organizations/:organization_id/reviews/:review_id/flag_violations/:flag_violation_id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "decision": "exception_approved"
}'

Example Request Body

{
  "decision": "exception_approved"
}

json

application/json

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "decision": "exception_approved",
    "created_at": "2024-08-25T15:00:00Z",
    "document_references": [
      "string"
    ],
    "reasoning": "reasoning",
    "remedy_suggested": "remedy_suggested",
    "reviewer": "test@example.com",
    "rule": "rule",
    "summary_review_flag_id": "00000000-0000-0000-0000-000000000000",
    "summary_review_id": "00000000-0000-0000-0000-000000000000",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Download review bundle (ZIP)

GET

https://api.gerri.commonpaper.com

/v1/organizations/{organization_id}/reviews/{review_id}/downloads

Downloads a .zip archive containing the original contract, processed (redlined) document, and audit trail for a RedlineReview.

SummaryReview is not supported — this endpoint returns 422 for summary reviews. Use GET /v1/organizations/{organization_id}/reviews/{review_id}/downloads/original instead.

Example:

Code
GET /v1/organizations/{organization_id}/reviews/{review_id}/downloads

Download review bundle (ZIP) › path Parameters

organization_id

string · uuid · required

Organization id

review_id

string · uuid · required

Review id

Download review bundle (ZIP) › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Download review bundle (ZIP) › Responses

ZIP archive (application/zip).

string · binary

Download review audit document

GET

https://api.gerri.commonpaper.com

/v1/organizations/{organization_id}/reviews/{review_id}/downloads/audit

Downloads the audit document for a RedlineReview.

SummaryReview is not supported — returns 422. Use GET /v1/organizations/{organization_id}/reviews/{review_id}/downloads/original for summary reviews.

Example:

Code
GET /v1/organizations/{organization_id}/reviews/{review_id}/downloads/audit

Download review audit document › path Parameters

organization_id

string · uuid · required

Organization id

review_id

string · uuid · required

Review id

Download review audit document › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Download review audit document › Responses

Audit document download (typically .docx).

string · binary

Download processed (redlined) contract

GET

https://api.gerri.commonpaper.com

/v1/organizations/{organization_id}/reviews/{review_id}/downloads/processed

Downloads the processed (redlined) contract for a RedlineReview.

SummaryReview is not supported — returns 422. Use GET /v1/organizations/{organization_id}/reviews/{review_id}/downloads/original for summary reviews.

Example:

Code
GET /v1/organizations/{organization_id}/reviews/{review_id}/downloads/processed

Download processed (redlined) contract › path Parameters

organization_id

string · uuid · required

Organization id

review_id

string · uuid · required

Review id

Download processed (redlined) contract › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Download processed (redlined) contract › Responses

Processed document (typically .docx, or application/pdf when applicable).

string · binary

Download original uploaded contract

GET

https://api.gerri.commonpaper.com

/v1/organizations/{organization_id}/reviews/{review_id}/downloads/original

Downloads the original uploaded contract (.docx or .pdf, depending on the upload). Supported for both RedlineReview and SummaryReview — this is the only download path available for summary reviews.

Example:

Code
GET /v1/organizations/{organization_id}/reviews/{review_id}/downloads/original

Download original uploaded contract › path Parameters

organization_id

string · uuid · required

Organization id

review_id

string · uuid · required

Review id

Download original uploaded contract › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Download original uploaded contract › Responses

Original file: application/vnd.openxmlformats-officedocument.wordprocessingml.document (.docx) or application/pdf.

string · binary

Imported Files