Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • SubmissionProperties

Index

Properties

Optional action

Types of content submission actions.

  • Possible values:
  • Scan: Start scan immediately.
  • Check Credits: Check how many credits will be used for this scan.
  • Index Only: Only index the file in the Copyleaks internal database. No credits will be used.

Optional author

Check inner properties for more details.

Optional cheatDetection

cheatDetection: boolean

When set to true the submitted document will be checked for cheating. If a cheating will be detected, a scan alert will be added to the completed webhook.

Optional developerPayload

developerPayload: string

Add custom developer payload that will then be provided on the webhooks. https://api.copyleaks.com/documentation/v3/webhooks

Optional exclude

Check inner properties for more details.

Optional expiration

expiration: number

Specify the maximum life span of a scan in hours on the Copyleaks servers.

When expired, the scan will be deleted and will no longer be accessible.

Optional filters

Check inner properties for more details.

Optional includeHtml

includeHtml: boolean

By default, Copyleaks will present the report in text format. If set to true, Copyleaks will also include html format.

Optional indexing

Check inner properties for more details.

Optional pdf

Check inner properties for more details.

Optional sandbox

sandbox: boolean

You can test the integration with the Copyleaks API for free using the sandbox mode.

You will be able to submit content for a scan and get back mock results, simulating the way Copyleaks will work to make sure that you successfully integrated with the API.

Turn off this feature on production environment.

Optional scanning

Check inner properties for more details.

Optional sensitiveDataProtection

sensitiveDataProtection: SubmissionSensitiveData

Check inner properties for more details.

Optional sensitivityLevel

sensitivityLevel: number

You can control the level of plagiarism sensitivity that will be identified according to the speed of the scan. If you prefer a faster scan with the results that contains the highest amount of plagiarism choose 1, and if a slower, more comprehensive scan, that will also detect the smallest instances choose 5.

webhooks

Generated using TypeDoc