### Hierarchy

- SubmissionProperties

## Index

### Properties

- action
- author
- cheatDetection
- developerPayload
- exclude
- expiration
- filters
- includeHtml
- indexing
- pdf
- sandbox
- scanning
- sensitiveDataProtection
- sensitivityLevel
- webhooks

## Properties

### Optional action

action: SubmissionActions

- Defined in src/models/submissions/properties/SubmissionProperties.ts:78

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

author: SubmissionAuthor

- Defined in src/models/submissions/properties/SubmissionProperties.ts:82

Check inner properties for more details.

### Optional cheatDetection

cheatDetection: boolean

- Defined in src/models/submissions/properties/SubmissionProperties.ts:69

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

- Defined in src/models/submissions/properties/SubmissionProperties.ts:45

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

### Optional exclude

exclude: SubmissionExclude

- Defined in src/models/submissions/properties/SubmissionProperties.ts:98

Check inner properties for more details.

### Optional expiration

expiration: number

- Defined in src/models/submissions/properties/SubmissionProperties.ts:59

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

filters: SubmissionFilter

- Defined in src/models/submissions/properties/SubmissionProperties.ts:86

Check inner properties for more details.

### Optional includeHtml

includeHtml: boolean

- Defined in src/models/submissions/properties/SubmissionProperties.ts:40

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

### Optional indexing

indexing: SubmissionIndexing

- Defined in src/models/submissions/properties/SubmissionProperties.ts:94

Check inner properties for more details.

### Optional pdf

pdf: SubmissionPDF

- Defined in src/models/submissions/properties/SubmissionProperties.ts:102

Check inner properties for more details.

### Optional sandbox

sandbox: boolean

- Defined in src/models/submissions/properties/SubmissionProperties.ts:53

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

scanning: SubmissionScanning

- Defined in src/models/submissions/properties/SubmissionProperties.ts:90

Check inner properties for more details.

### Optional sensitiveDataProtection

sensitiveDataProtection: SubmissionSensitiveData

- Defined in src/models/submissions/properties/SubmissionProperties.ts:106

Check inner properties for more details.

### Optional sensitivityLevel

sensitivityLevel: number

- Defined in src/models/submissions/properties/SubmissionProperties.ts:65

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

webhooks: SubmissionWebhooks

- Defined in src/models/submissions/properties/SubmissionProperties.ts:36

Generated using TypeDoc