Copyleaks allows users to upload and index their existing documents into the Copyleaks Shared Data Hub without performing a scan. This feature enables future submissions to be compared against these stored documents for enhanced plagiarism detection. To activate the indexing mode, submit your content with the properties.action=2 parameter. Indexing documents to the Copyleaks Shared Data Hub is free of charge. Once the document is processed, a webhook will notify you of the indexing status:
  • Success: A webhook will confirm that your document has been indexed successfully.
  • Error: If indexing fails, an error webhook will be triggered, providing details about the reason for the failure.

​
status
integer
The current status of the scan. Possible values: 0 (Success), 1 (Error), 2 (CreditsChecked), 3 (Indexed)
​
developerPayload
string
The developer payload that was provided in the submit method.<= 512 characters

​
Example

{
  "status": 3,
  "developerPayload": "Custom developer payload"
}

​
Next Steps

Webhooks Overview

Learn about the different types of webhooks and how to handle them.

Submit File for Scan

Learn how to submit files for scanning, including enabling indexing.

Compare Multiple Documents

Understand how to compare documents within your Private Cloud Hub and against other sources.