Find Answers by API

Compare Word Documents with NET REST API

This guide shows how to WordsApi and CompareDocumentOnline to compare DOCX documents using the Java REST API, providing a clear, step‑by‑step workflow for developers who need to detect changes between two Word files. For more information about the DOCX format, see the DOCX file info page.

Prerequisite

Steps Compare Two Word Docs with Java Low Code API

  1. Initialize the WordsApi object by setting the client ID and secret to compare the documents
  2. Read the latest Word file into a memory stream and upload it to cloud storage
  3. Create the CompareData object and use the uploaded file as a reference
  4. Read the original Word file into a memory stream
  5. Create the CompareDocumentOnlineRequest object by providing the original file, the updated file, and the desired output file name
  6. Invoke the CompareDocumentOnline method and pass the request object
  7. Download the output Word file from the response and save it locally

The steps above illustrate how to compare Word docs online with Java Low Code API. Begin by uploading the latest Word file to cloud storage, then create a CompareData object that references the uploaded document. Load the original file, build a CompareDocumentOnlineRequest with both documents and the output name, and finally call CompareDocumentOnline to obtain the comparison result.

Code to Compare Word Documents Online with Java REST API

This sample demonstrates how to compare differences between two Word documents using the Java REST API. It first uploads the newer Word file to cloud storage as a reference, then reads the previous version locally. The CompareData class includes a CompareOptions property that lets you customize the comparison—such as ignoring case changes, comments, fields, footnotes, formatting, headers and footers, tables, and text boxes.

In this topic, we learned to compare two Word files. For information on removing comments from a Word document, see the article: Delete Comments in Word DOC with Java REST API.

Keywords: compare word files with Java Low Code API; compare word documents with NET REST API; compare word documents online with NET REST API; compare differences between two word documents with Java REST API.