/v3/businesses/submit/file/{scanId}
Scan files to find where the content has been used elsewhere and check its originality. Using submit-file you can scan various file types for plagiarism and identify copied content. See supported formats.
For integration testing purposes, use sandbox mode - for free.
Request
URL Parameters
scanId We recommend you use the same id in your database to represent the scan in the Copyleaks database. This will help you to debug incidents.
Using the same ID for the same file will help you to avoid network problems that may lead to multiple scans for the same file.
Allowed characters are [a-zA-Z0-9] and the following symobols: [email protected]$^&-+%=_(){}<>';:/.",~`|
Body Parameters
base64 aGVsbG8gd29ybGQ= filename Myfile.pdf Max length: 255 characters. properties.webhooks.status Use the special token {STATUS} to track the current scan status. This special token will automatically be replaced by the Copyleaks servers with the optional values: completed, error, creditsChecked and indexed.
Read more about webhooks.
https://yoursite.com/webhook/{STATUS}Request Example
PUT https://api.copyleaks.com/v3/businesses/submit/file/my-custom-id
Content-Type: application/json;
Authorization: Bearer YOUR-LOGIN-TOKEN;
{
"base64": "SGVsbG8gd29ybGQh",
"filename": "file.txt",
"properties": {
"webhooks": {
"status": "https://yoursite.com/webhook/{STATUS}/my-custom-id"
}
}
}
Response
Codes
201 400 {
"properties.webhooks.status": [
"The field is required."
]
}401 Authorization has been denied for this request.
409 429 This method has a maximum call limit of 12 calls within 15 minutes.
Other resources:
- Performance ConsiderationsImportant! - How to improve your scan performance.
- Exponential Backoff - Algorithm that helps applications define a retry strategy for consuming a network service.
- Technical Specifications - See API's limits and supported formats.
Do you have a technical question?
Use stackoverflow.com to get help from our development team and other Copyleaks users.