API Version 3 Documentation

The Copyleaks API is a powerful, comprehensive and open-source solution that provides an additional layer of content authentication, plagiarism and copyright infringement detection to any platform.

Here you can find all the needed documentation for a seamless integration including SDKs with code examples, methods documentation, technical specifications and more:

REST API methods:

• Account Methods - First step when using the API: log in using your account's credentials. Relevant for both Business and Education.
• Business Methods - All relevant methods for using the Business API, after you are verified using the Account Methods.
• Education Methods - All relevant methods for using the Education API, after you are verified using the Account Methods.
• Downloads Methods - Allows you to build the report yourself (if you don’t want to use the standard Copyleaks report).

Getting set up?

play_circle_outline

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 (Business / Education) 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

Branded PDF Report

Quick to integrate

Easy to configure and get results

Requires few development resources

Use as proof for archiving purposes

Interactive Report

Recommended

Easily embedded anywhere

Completely interactive and dynamic view of the results

Provides multiple views of similar instances including side-by-side comparisons

Requires few development resources

play_circle_outline

Start Here

White Label Customization

All data is available to be shown however you want

Use your own custom branding and design to make the report fit your platform

Show as much or as little information as you want to your end user

The most valuable way to use the Copyleaks API without additional costs

Other Resources

• Release Notes - Official updates channel.
• Technical Specifications - See API's limits and supported formats.
• 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.