DOCX Compare API

Compare Word documents for differences in content and formatting

DOCX Compare features

The DOCX Compare API allows for comparing two Word document versions to identify differences using revision marks.

It offers various customization options including the ability to specify comparison granularity at the word or character level, whether to compare formatting, case changes, whitespace, tables, headers and footers, footnotes and endnotes, textboxes, fields, comments, document moves, and whether to accept revisions before comparison.

This is useful for efficiently managing document revisions in collaborative environments such as legal, academic, and corporate settings.

API Endpoint

ConvertAPI offers a cloud-based solution, which makes DOCX Compare conversion effortless with just a single REST-API call:

        HTTP POST
    
https://v2.convertapi.com/convert/docx/to/compare

Postman OpenAPI cURL CLI

Authenticate your API call

Converting docx to compare via REST-API is now easier than ever. Sign up for a free account to obtain your authentication secret, append it as a query string parameter to the conversion URL, and voilà! You can find advanced authentication techniques in our docs.

        QUERY AUTHENTICATION
    
https://v2.convertapi.com/convert/docx/to/compare?auth=secret_or_token

DOCX Compare using REST-API in no time!

Once you have your authentication in place, you can convert your files using application/json, multipart/form-data and application/octet-stream content types. A simple HTTP POST request using JSON would look like this:

// Code snippet is using the ConvertAPI JavaScript Client: https://github.com/ConvertAPI/convertapi-js

// Code snippet is using the ConvertAPI Node.js Client: https://github.com/ConvertAPI/convertapi-nodejs

// Code snippet is using the ConvertAPI PHP Client: https://github.com/ConvertAPI/convertapi-php

// Code snippet is using the ConvertAPI Java Client: https://github.com/ConvertAPI/convertapi-java

// Code snippet is using the ConvertAPI C# Client: https://github.com/ConvertAPI/convertapi-dotnet

# Code snippet is using the ConvertAPI Ruby Client: https://github.com/ConvertAPI/convertapi-ruby

# Code snippet is using the ConvertAPI Python Client: https://github.com/ConvertAPI/convertapi-python

// Code snippet is using the ConvertAPI Go Client: https://github.com/ConvertAPI/convertapi-go

REM Code snippet is using the command line utility program: https://github.com/ConvertAPI/convertapi-cli

Conversion request using cURL

You can easily convert docx to compare with a simple cURL request. Our documentation provides more advanced cURL request techniques.

File conversion using CLI

ConvertAPI CLI allows you to convert files using our command-line file conversion utility tool. Check out CLI documentation for a detailed explanation and usage examples.

REM Code snippet is using the command line utility program: https://github.com/ConvertAPI/convertapi-cli

Try the conversion online - no coding required!

You can try out advanced conversion parameters and test the conversion result online using our interactive demo tool. This tool will produce the same conversion output as if you were using the library from your solution, and it will auto-generate the code snippet for you!

Try for FREE!

Conversion parameters

Password String

Sets the password to open protected documents.

CompareLevel Collection

The property defines the granularity of comparisons between documents or text segments. It determines the precision of the comparison process, allowing users to specify whether differences are identified based on larger text blocks, such as words or sentences, or at a more detailed level, such as characters or formatting.

Values: Word Character

CompareFormatting Bool

Determines whether to indicate variations in formatting between the two documents.

CompareCaseChanges Bool

Determines whether to highlight discrepancies in capitalization between the two documents.

CompareWhitespace Bool

Determines whether to identify dissimilarities in whitespace, such as gaps or paragraphs, between the two documents.

CompareTables Bool

Determines whether to evaluate variations in the information presented within tables between the two documents.

CompareHeaders Bool

Determines whether to contrast divergences in headers and footers between the two documents.

CompareFootnotes Bool

Determines whether to compare differences in footnotes and endnotes between the two documents.

CompareTextboxes Bool

Determines whether to assess differences in the information presented within text boxes between the two documents.

CompareFields Bool

Determines whether to detect disparities in fields between the two documents.

CompareComments Bool

Determines whether to evaluate distinctions in comments between the two documents.

CompareMoves Bool

Indicates the name of the individual to credit for modifications when comparing the two documents.

AcceptRevisions Bool

Specifies whether to accept revisions before document comparison.

RevisionAuthor String

Author name who made revision.