Compare two documents

Comparing documents is often used to track changes made to important documents. Additionally, it is used in editing to compare the modified document version with the original.

Aspose.Words REST API is a powerful document manipulation tool that allows developers to compare two documents and retrieve the differences between them.

As a result of the comparison, a list of differences between the two Word documents is returned. Each difference will contain information about the type of difference (e.g. deleted text, added text, formatting change), the location of the difference in the document, and the text that was added or deleted.

Compare two documents REST API

Server Method Endpoint PUT /words/online/put/compareDocument

You can use the following parameters in a REST request:

Parameter Name Data Type Required/Optional Description
loadEncoding string Optional Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
password string Optional Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API.
encryptedPassword string Optional Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
destFileName string Optional Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
encryptedPassword2 string Optional encrypted password for the second document.

Use $multipart/form-data request to combine one or more properties into a single body:

Property Name Data Type Required/Optional Description
document string(binary) Required The document.
compareData CompareData Required Compare data.
comparingDocument string(binary) Optional The comparing document.

Compare two documents usage examples

Let’s look at practical examples of using the web service. You can do this both with cURL and Postman utilities, and from your code in various programming languages: Python, Java, JavaScript, C#, PHP, C++, Go, Ruby, Swift, Dart.

How to compare twodocuments with cURL or Postman

One of the easiest and fastest ways to call a REST API is to use cURL or Postman:

How to compare two documents in Python, Java, C#, C++, JavaScript and other programming languages

Using SDK is the quickest way to speed up the development. Please take a look at the provided code examples to quickly call this web service from your favourite programming language:

See Also

  • GitHub repository — explore Aspose.Words Cloud SDK Family. These software libraries take care of all low-level document-processing details.