The Copyleaks Authenticity API allows you to integrate your institution’s platform, learning management system or any other e-learning solution with Copyleaks products.

Endpoints

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

DELETE 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

POST v3/downloads/{scanId}/export/{exportId}

Export your scan report by providing a scan ID.

GET v3/repositories/repository/{repositoryId}/info

Get information about your Private Cloud Hubs.

GET v3/miscellaneous/supported-file-types

Get a list of supported file types.

GET v3/miscellaneous/ocr-supported-languages

Get a list of supported languages for OCR.

GET v3/miscellaneous/supported-cross-languages

Get a list of supported languages for cross-language scans.

Webhooks

POST Completed

Fired on scan completion 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)