Skip to navigation

Perform compare on two documents

View as Markdown

Perform a compare on two documents.

Developing with the CLM API is only available for CLM customers with a production account. To purchase a plan to gain access to the CLM API, contact Docusign Sales.

Authentication

AuthorizationBearer

Docusign OAuth 2.0 access token, sent as Authorization: Bearer <token>.

Path parameters

accountIdstringRequiredformat: "uuid"
The ID of the Docusign account.

Request

DocumentCompareTask containing data needed to reference the merge task.
MessagestringOptional
Detailed message information returning to the API caller.
DownloadUrlstringOptional
The URI where the document can be downloaded.
StatusstringOptional
Current status of the asynchronous task
HrefstringOptional
Uri where the object can be retrieved.
OriginalDocumentobjectOptional
The first document used for comparison. This can be any document.
RevisedDocumentobjectOptional
The second document used for comparison. This can be any document.

Response

OK
MessagestringOptional
Detailed message information returning to the API caller.
DownloadUrlstringOptional
The URI where the document can be downloaded.
StatusstringOptional
Current status of the asynchronous task
HrefstringOptional
Uri where the object can be retrieved.
OriginalDocumentobjectOptional
The first document used for comparison. This can be any document.
RevisedDocumentobjectOptional
The second document used for comparison. This can be any document.