BOOK A DEMO
LOGIN
Homekeyboard_arrow_rightDocumentationkeyboard_arrow_rightVersion 3keyboard_arrow_rightBusiness

Businesses Documentation

Copyleaks Businesses 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/businesses/submit/url/{scanId}
Starting a new process by providing a URL to scan.
PUT
v3/businesses/submit/file/{scanId}
Starting a new process by providing a file to scan.
PUT
v3/businesses/submit/ocr/{scanId}
Starting a new process by providing an image file with text to scan.
PATCH
v3/businesses/start
Start scanning a list of creditsChecked scans
PATCH
v3/businesses/batch/start
Start batch scanning a list of creditsChecked scans.
PATCH
v3.1/businesses/delete
Delete the specific scans from the server, after getting the scan results.
POST
v3/businesses/scans/{scanId}/webhooks/resend
Resend webhooks for existing scans.
GET
v3/businesses/credits
Get your credit balance.
GET
v3/businesses/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).

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

  • Manage your credits
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.