POST

Indexed

Copyleaks allows users to upload and index their existing documents into the Copyleaks internal database, without being scanned. This allows the users future submissions to also be compared against their previously stored documents. You can activate the indexing mode by submitting content with the properties.action=2 Indexing documents to the Copyleaks internal database is free of charge. The main goal of this webhook is to inform you that your document has been indexed successfully. If not, an error webhook will be fired with the reason for the error.

Name

Description

status

The current status of the scan.

Integer

Possible values:
0 : Success
1 : Error
2 : CreditsChecked
3 : Indexed

developerPayload

The developer payload that was provided in the submit method.

String

Max Length: 512 characters

Example

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

Other resources:

Webhooks Security - Security aspects when protecting your endpoints from unauthorized access.

Do you have a technical question?

Use stackoverflow.com to get help from our development team and other Copyleaks users.

Ask a Question