Document Reviews

Submit documents for review, track processing status, and retrieve completed findings.

List document reviews

get

Return document reviews visible to the authenticated tenant. This endpoint is typically used to poll or reconcile asynchronous reviews in bulk.

Authorizations

bearerApiKey

AuthorizationstringRequired

Supply the Protege external API key in the Authorization header using the format Bearer <api_key>.

Query parameters

idstring · uuidOptional

Filter by a specific review identifier.

documentEvaluationTypeIdstring · uuidOptional

Filter reviews created with a specific document evaluation type.

externalIdstringOptional

Filter by the client-supplied external document identifier.

statusstring · enumOptional

Current processing state of a submitted document review.

Possible values:

limitintegerOptional

Maximum number of records to return per page.

Default: 25

offsetintegerOptional

Number of records to skip before starting the page.

Default: 0

sortBystring · enumOptional

Field used to sort the result set.

Default: createdAtPossible values:

sortOrderstring · enumOptional

Sort direction for the selected sort field.

Default: descPossible values:

Responses

200

Document reviews page

application/json

Paginated collection of reviews visible to the calling API key.

400

Invalid query parameters

application/json

401

Missing or invalid API key

application/json

429

Rate limit exceeded

application/json

500

Failed to list document reviews

application/json

get/api/v1/document-reviews

HTTPcURLJavaScriptPython

GET /api/v1/document-reviews HTTP/1.1
Host: sandbox.tryprotege.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "documentReviews": [
    {
      "id": "88888888-8888-8888-8888-888888888888",
      "status": "completed",
      "documentId": "99999999-9999-9999-9999-999999999999",
      "documentEvaluationTypeId": "22222222-2222-2222-2222-222222222222",
      "document": {
        "title": "MSA draft",
        "fileType": "TEXT",
        "externalId": "client-doc-123"
      },
      "createdAt": "2026-05-15T00:00:00.000Z",
      "updatedAt": "2026-05-15T00:00:05.000Z"
    }
  ],
  "page": {
    "limit": 25,
    "offset": 0,
    "count": 1,
    "total": 1
  }
}

Create a document review

post

Submit a document for compliance review. Use JSON for plain-text content or multipart form data for file uploads. Synchronous requests return findings inline; asynchronous requests return a queued review that can be polled later.

Authorizations

bearerApiKey

AuthorizationstringRequired

Supply the Protege external API key in the Authorization header using the format Bearer <api_key>.

Body

application/jsonmultipart/form-data

JSON request body for creating a review from plain text content.

modestring · enumOptional

Controls whether the review should complete inline or be queued for background processing.

Default: syncPossible values:

documentEvaluationTypeIdstring · uuidRequired

Identifier of the review configuration to apply.

Responses

200

Sync review completed

application/json

Final response returned when a document review has completed successfully.

idstring · uuidRequired

statusstring · enumRequiredPossible values:

modestring · enumRequired

Controls whether the review should complete inline or be queued for background processing.

Default: syncPossible values:

documentIdstring · uuidRequired

documentEvaluationTypeIdstring · uuidRequired

202

Async review accepted

application/json

400

Validation or sync-limit error

application/json

401

Missing or invalid API key

application/json

404

Document evaluation type not found

application/json

415

Unsupported content type

application/json

429

Rate limit exceeded

application/json

post/api/v1/document-reviews

HTTPcURLJavaScriptPython

POST /api/v1/document-reviews HTTP/1.1
Host: sandbox.tryprotege.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 236

{
  "mode": "sync",
  "documentEvaluationTypeId": "22222222-2222-2222-2222-222222222222",
  "document": {
    "type": "text",
    "title": "MSA draft",
    "externalId": "client-doc-123",
    "text": "Full review text goes here",
    "metadata": {
      "sourceSystem": "partner-api"
    }
  }
}

application/jsonmultipart/form-data

{
  "id": "88888888-8888-8888-8888-888888888888",
  "status": "completed",
  "mode": "sync",
  "documentId": "99999999-9999-9999-9999-999999999999",
  "documentEvaluationTypeId": "22222222-2222-2222-2222-222222222222",
  "document": {
    "title": "MSA draft",
    "fileType": "TEXT",
    "externalId": "client-doc-123"
  },
  "findings": [
    {
      "kind": "policy_feedback",
      "text": "Guaranteed 20% return",
      "comment": "This claim appears unqualified and may require substantiation.",
      "riskLevel": "high",
      "feedbackLocation": "text",
      "location": {
        "pageNumber": 1
      },
      "status": "flagged",
      "approval": null,
      "metadata": null,
      "formattedOutput": null,
      "policy": {
        "id": "11111111-1111-1111-1111-111111111111",
        "name": "No unqualified claims"
      },
      "trademark": null,
      "details": {
        "recommendation": "Add supporting disclosure or revise the claim."
      }
    }
  ]
}

Get document review status or result

get

Retrieve the latest state of a specific document review. Completed reviews include findings; pending reviews expose queue or processing status.

Authorizations

bearerApiKey

AuthorizationstringRequired

Supply the Protege external API key in the Authorization header using the format Bearer <api_key>.

Path parameters

reviewIdstring · uuidRequired

Responses

200

Review status or completed result

application/json

or

400

Missing review id

application/json

401

Missing or invalid API key

application/json

404

Review not found

application/json

429

Rate limit exceeded

application/json

get/api/v1/document-reviews/{reviewId}

HTTPcURLJavaScriptPython

GET /api/v1/document-reviews/{reviewId} HTTP/1.1
Host: sandbox.tryprotege.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "88888888-8888-8888-8888-888888888888",
  "status": "completed",
  "mode": "sync",
  "documentId": "99999999-9999-9999-9999-999999999999",
  "documentEvaluationTypeId": "22222222-2222-2222-2222-222222222222",
  "document": {
    "title": "MSA draft",
    "fileType": "TEXT",
    "externalId": "client-doc-123"
  },
  "findings": []
}