You have granular control over what content is scanned and what data is stored when you submit a document to Copyleaks. This guide covers two distinct types of exclusion:

1. Excluding Parts of a Document from Scan Analysis: This allows you to refine the plagiarism scan by ignoring specific elements like quotes or code blocks.
2. Preventing a Document from Being Indexed: This allows you to control whether the entire document is added to the Copyleaks Internal Database for future comparisons.

---

Exclude Options

The exclude object can contain the following boolean properties:

• quotes: If set to true, all text within quotation marks will be ignored.
• citations: If set to true, citations and references will be ignored.
• references: If set to true, the bibliography or reference list will be ignored.
• tableOfContents: If set to true, the table of contents will be ignored.
• titles: If set to true, titles and headings will be ignored.
• code: If set to true, code blocks will be ignored.

Request Example

HTTP

PUT https://api.copyleaks.com/v3/scans/submit/file/my-scan-exclude-example
Content-Type: application/json
Authorization: Bearer YOUR_LOGIN_TOKEN

{
  "base64": "VGhpcyBpcyBhIHRlc3QgZmlsZS4gIkhlbGxvLCB3b3JsZCEiIGlzIGEgcXVvdGUuIChTbWl0aCwgMjAyMyk=",
  "filename": "document-with-exclusions.txt",
  "properties": {
    "webhooks": {
      "status": "https://my-server.com/webhook/{STATUS}"
    },
    "exclude": {
      "quotes": true,
      "citations": true
    },
    "sandbox": true
  }
}

cURL

curl --request PUT \
  --url https://api.copyleaks.com/v3/scans/submit/file/my-scan-exclude-example \
  --header 'Authorization: Bearer YOUR_LOGIN_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "base64": "VGhpcyBpcyBhIHRlc3QgZmlsZS4gIkhlbGxvLCB3b3JsZCEiIGlzIGEgcXVvdGUuIChTbWl0aCwgMjAyMyk=",
    "filename": "document-with-exclusions.txt",
    "properties": {
      "webhooks": {
        "status": "https://my-server.com/webhook/{STATUS}"
      },
      "exclude": {
        "quotes": true,
        "citations": true
      },
      "sandbox": true
    }
  }'

Python

import requests
import base64

# Sample document content with quotes and citations
document_content = 'This is a test file. "Hello, world!" is a quote. (Smith, 2023)'
base64_content = base64.b64encode(document_content.encode()).decode('utf-8')

url = "https://api.copyleaks.com/v3/scans/submit/file/my-scan-exclude-example"
payload = {
    "base64": base64_content,
    "filename": "document-with-exclusions.txt",
    "properties": {
        "webhooks": {
            "status": "https://my-server.com/webhook/{STATUS}"
        },
        "exclude": {
            "quotes": True,
            "citations": True,
            "references": True,
            "tableOfContents": False,
            "titles": False,
            "code": False
        },
        "sandbox": True
    }
}
headers = {
    "Authorization": "Bearer YOUR_LOGIN_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json"
}

response = requests.put(url, json=payload, headers=headers)
result = response.json()

print("Scan submitted with exclusions!")
if 'scannedDocument' in result:
    print(f"Total words: {result['scannedDocument'].get('totalWords', 'N/A')}")
    print(f"Excluded words: {result['scannedDocument'].get('totalExcluded', 'N/A')}")

print("Full response:", result)

JavaScript

const { Copyleaks } = require('plagiarism-checker');

const EMAIL_ADDRESS = "[email protected]";
const API_KEY = "your-api-key-here";

async function submitFileWithExclusions() {
    const copyleaks = new Copyleaks();

    // Login first
    const authToken = await copyleaks.loginAsync(EMAIL_ADDRESS, API_KEY);
    console.log('Logged successfully!\nToken:', authToken);

    // Sample document content with quotes and citations
    const documentContent = 'This is a test file. "Hello, world!" is a quote. (Smith, 2023)';
    const base64Content = Buffer.from(documentContent).toString('base64');

    // Submit file with exclusions
    const scanId = "my-scan-exclude-example";
    const fileSubmission = {
        base64: base64Content,
        filename: "document-with-exclusions.txt",
        properties: {
            webhooks: {
                status: "https://my-server.com/webhook/{STATUS}"
            },
            exclude: {
                quotes: true,
                citations: true,
                references: true,
                tableOfContents: false,
                titles: false,
                code: false
            },
            sandbox: true
        }
    };

    try {
        const result = await copyleaks.submitFileAsync(authToken, scanId, fileSubmission);

        console.log('File submitted with exclusions successfully!');
        if (result.scannedDocument) {
            console.log('Total words:', result.scannedDocument.totalWords || 'N/A');
            console.log('Excluded words:', result.scannedDocument.totalExcluded || 'N/A');
        }
        console.log('Full result:', result);

        return result;
    } catch (error) {
        console.error('Failed to submit file with exclusions:', error);
    }
}

submitFileWithExclusions();

Java

import classes.Copyleaks;
import models.submissions.CopyleaksFileSubmissionModel;
import models.submissions.properties.*;
import java.util.Base64;
import java.nio.charset.StandardCharsets;

public class FileExclusionExample {
    private static final String EMAIL_ADDRESS = "[email protected]";
    private static final String API_KEY = "00000000-0000-0000-0000-000000000000";

    public static void main(String[] args) {
        try {
            // Login to Copyleaks
            String authToken = Copyleaks.login(EMAIL_ADDRESS, API_KEY);
            System.out.println("Logged successfully!\nToken: " + authToken);

            // Sample document content with quotes and citations
            String documentContent = "This is a test file. \"Hello, world!\" is a quote. (Smith, 2023)";
            String base64Content = Base64.getEncoder().encodeToString(
                documentContent.getBytes(StandardCharsets.UTF_8)
            );

            // Configure webhooks
            SubmissionWebhooks webhooks = new SubmissionWebhooks("https://my-server.com/webhook/{STATUS}");

            // Create submission properties with exclusions
            SubmissionProperties properties = new SubmissionProperties(webhooks);
            properties.setSandbox(true);

            // Configure exclusions
            SubmissionExclude exclude = new SubmissionExclude();
            exclude.setQuotes(true);
            exclude.setCitations(true);
            exclude.setReferences(true);
            exclude.setTableOfContents(false);
            exclude.setTitles(false);
            exclude.setCode(false);
            properties.setExclude(exclude);

            // Create file submission with exclusions
            String scanId = "my-scan-exclude-example";
            CopyleaksFileSubmissionModel fileSubmission = new CopyleaksFileSubmissionModel(
                base64Content,
                "document-with-exclusions.txt",
                properties
            );

            // Submit file for scanning
            var result = Copyleaks.submitFile(authToken, scanId, fileSubmission);

            System.out.println("File submitted with exclusions successfully!");
            System.out.println("Scan ID: " + scanId);
            System.out.println("Document will exclude quotes and citations from analysis.");

        } catch (Exception e) {
            System.out.println("Failed: " + e.getMessage());
            e.printStackTrace();
        }
    }
}

Response Example

When the scan is processed, the scannedDocument object in the response will reflect the number of words that were excluded.

201

201 Created

The scan was successfully created and is now processing. The excluded word count is reflected in the response.

Example Response

A typical response from this endpoint:

Show full example (39 lines)

{
  "scannedDocument": {
    "scanId": "my-scan-exclude-example",
    "totalWords": 8,
    "totalExcluded": 4,
    "credits": 0,
    "expectedCredits": 1,
    "creationTime": "2025-08-10T10:00:00.000000Z",
    "metadata": {
      "filename": "document-with-exclusions.txt"
    },
    "enabled": {
      "plagiarismDetection": true,
      "aiDetection": false,
      "explainableAi": false,
      "writingFeedback": false,
      "pdfReport": true,
      "cheatDetection": false,
      "aiSourceMatch": false
    },
    "detectedLanguage": "en"
  },
  "results": {
    "score": {
      "identicalWords": 0,
      "minorChangedWords": 0,
      "relatedMeaningWords": 0,
      "aggregatedScore": 0
    },
    "internet": [],
    "database": [],
    "batch": [],
    "repositories": []
  },
  "notifications": {},
  "writingFeedback": {},
  "status": 0,
  "developerPayload": ""
}

{
  "scannedDocument": {
    "scanId": "my-scan-exclude-example",
    "totalWords": 8,
    "totalExcluded": 4,
    "credits": 0,
    "expectedCredits": 1,
    "creationTime": "2025-08-10T10:00:00.000000Z",
    "metadata": {
      "filename": "document-with-exclusions.txt"
    },
    "enabled": {
      "plagiarismDetection": true,
      "aiDetection": false,
      "explainableAi": false,
// ... truncated

🗺️ Next Steps

Webhooks Overview Learn how to securely receive and process notifications from Copyleaks.

Viewing Scan Results Understand the scan result format and how to display it to your users.