BOOK A DEMO
LOGIN
Homekeyboard_arrow_rightDocumentationkeyboard_arrow_rightVersion 3keyboard_arrow_rightPlagiarism Check

Plagiarism Check Documentation

Copyleaks Scans API allows you to integrate your institution's platform, learning management system or any other e-learning solution with Copyleaks plagiarism detection products.

API
Description
PUT
v3/scans/submit/url/{scanId}
Starting a new process by providing a URL to scan.
PUT
v3/scans/submit/file/{scanId}
Starting a new process by providing a file to scan.
PUT
v3/scans/submit/ocr/{scanId}
Starting a new process by providing an image file with text to scan.
PATCH
v3/scans/start
Start scanning a list of creditsChecked scans
PATCH
v3.1/scans/delete
Delete the specific scans from the server, after getting the scan results.
POST
v3/scans/{scanId}/webhooks/resend
Resend webhooks for existing scans.
GET
v3/scans/credits
Get your credit balance.
GET
v3/scans/usages/history
Get your usage history between two dates.
Supportedwebhooks :
Name
Description
POST
Completed
Fired on scan-completed event.
POST
Error
Fired on scan ended with an error.
POST
Indexed
Fires on DB index event.
POST
Credits Checked
Fired when credits were checked.
POST
New Result
Fired as soon as we collect a new result (while scanning).

Getting set up?

We got you covered!

play_circle_outline

The integration process is simple and includes three steps:

assets/images/diagrams/new-horizontal-V3-general-flow.png
  1. Log in to Copyleaks Use your personal identification information (email and API key) to prove your identity. When the server accepts your login information, you will receive a token that will be used to identify yourself in later calls.
  2. Submit a scan  Submit your content to be checked for plagiarism, using the right method for your content type (files, images with text or URLs). You can also add properties to the call to customize the scan and results for your specific needs.
  3. Wait for completion webhook The scan time may vary depending on multiple factors, but since Copyleaks is supporting the asynchronous model you will automatically get notified by your webhook whenever there is a change of status with your scan. For example, status change: the scan has been completed . Completed webhook informs you that the scanning process has completed. If the scan is completed successfully, you are ready to Export the scan outcomes.
  4. Export Methods to Extract Data The Export methods allow you to download data from Copyleaks. The different export options allow you to download the PDF report, the crawled version of your own submitted documents, and the results to your server.
  5. Export completed webhook gives you a report about your export task status. Choose to show the exported data in three different ways:
    • PDF Report
    • Open-source Plagiarism Report
    • Customized Data

There are three ways to present the data on your own platform:

Branded PDF Report
assets/present-card/card-list-item-icon.svg
Quick to integrate
assets/present-card/card-list-item-icon.svg
Easy to configure and get results
assets/present-card/card-list-item-icon.svg
Requires few development resources
assets/present-card/card-list-item-icon.svg
Use as proof for archiving purposes
recommended-title-icon.svg
Interactive Report
Recommended
assets/present-card/card-list-item-icon.svg
Easily embedded anywhere
assets/present-card/card-list-item-icon.svg
Completely interactive and dynamic view of the results
assets/present-card/card-list-item-icon.svg
Provides multiple views of similar instances including side-by-side comparisons
assets/present-card/card-list-item-icon.svg
Requires few development resources
play_circle_outline
White Label Customization
assets/present-card/card-list-item-icon.svg
All data is available to be shown however you want
assets/present-card/card-list-item-icon.svg
Use your own custom branding and design to make the report fit your platform
assets/present-card/card-list-item-icon.svg
Show as much or as little information as you want to your end user
assets/present-card/card-list-item-icon.svg
The most valuable way to use the Copyleaks API without additional costs

You can see the flow here (see full description ):

submit-flow

We also offer advanced activities to better fit your needs:

  • Compare your documents only against one another to find similarities.
  • Index your files in the Copyleaks internal database to later compare against them.
  • Upload a file and get a price quote before the scan begins. The price will be shown in credits (1 credit = 250 words).

Other Resources

  • Release Notes - Official updates channel.
  • Technical Specifications - See API's limits and supported formats.
  • Manage your credits
  • Performance Considerations Important! - How to improve your scan performance.
  • Present the Report on Your Site - have a complete white-labeled report, and present it on your domain.
  • Teams for API Users - Invite other users to send their own requests, view scan usage, and more.
  • System Status - Our system status is a real-time view of the uptime of our various services.
stack-overflow_icon.png

Do you have a technical question?

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

Ask a Question

PRODUCTS

Scans
Pricing
Copyleaks.com

RESOURCES

Documentation
Plagiarism Report
Help Center
System Status
Security

ABOUT

About us
Careers
Terms of Use
Privacy Policy
Sitemap

Copyleaks, Inc.

700 Canal St.
Stamford, CT 06902 USA

[email protected]

Copyleaks, Inc. All rights reserved. Use of this website signifies your agreement to the Terms of Use.