ConvertApi Logo
Sign up

DOCX to COMPARE API

The API for comparing two Word documents.

DOCX

The API for comparing two versions of a Word document to see how they differ using revision marks.

Advanced properties
Copy parameter's URL Secret Secret
Type: String

Authentication secret must be provided as a query parameter. If omitted, token must be provided.

Show all
Copy parameter's URL Token Token
Type: String

Authentication token must be provided as a query parameter. If omitted, secret must be provided.

Show all
Copy parameter's URL File File Required
Type: File

File to be converted. Value can be URL or file content.

Show all
Copy parameter's URL StoreFile Store file
Type: Bool

Store converted file on our secure server and provides download URL.

Default: False Show all
Copy parameter's URL FileName File name
Type: String

Converted output file name without extension. The extension will be added automatically.

Show all
Copy parameter's URL Timeout Timeout
Type: Integer

Conversion timeout in seconds.

Default: 900 Range: 10 .. 1200 Show all
Copy parameter's URL Password Open Password
Type: String

Sets the password to open protected documents.

Show all
Copy parameter's URL CompareFile Compare file Required
Type: File

Specifies the Word document with which the specified document is compared.

Show all
Copy parameter's URL CompareFormatting Compare formatting
Type: Bool

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

Default: True Show all
Copy parameter's URL CompareCaseChanges Compare case changes
Type: Bool

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

Default: True Show all
Copy parameter's URL CompareWhitespace Compare whitespace
Type: Bool

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

Default: True Show all
Copy parameter's URL CompareTables Compare tables
Type: Bool

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

Default: True Show all
Copy parameter's URL CompareHeaders Compare headers
Type: Bool

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

Default: True Show all
Copy parameter's URL CompareFootnotes Compare footnotes
Type: Bool

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

Default: True Show all
Copy parameter's URL CompareTextboxes Compare textboxes
Type: Bool

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

Default: True Show all
Copy parameter's URL CompareFields Compare fields
Type: Bool

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

Default: True Show all
Copy parameter's URL CompareComments Compare comments
Type: Bool

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

Default: True Show all
Copy parameter's URL CompareMoves Compare moves
Type: Bool

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

Default: True Show all
Copy parameter's URL AcceptRevisions Accept revisions
Type: Bool

Specifies whether to accept revisions before document comparison.

Default: False Show all

Code snippet

// 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

<!-- For conversions with the multiple file result please refer to this example: https://repl.it/@ConvertAPI/HTML-Form-with-multiple-file-result -->