completed event occurs once the scan process has been completed and the scan finished successfully.
Successful scans provide you all the output information from the scan process.
The current status of the scan. Possible values:
0 (Success), 1 (Error), 2 (CreditsChecked), 3 (Indexed)The developer payload that was provided in the submit method.
<= 512 charactersGeneral information about the scanned document.
Show scannedDocument properties
Show scannedDocument properties
The unique scan id provided by you.
Unsigned Integer. Total number of words found in the scanned text.
Unsigned Integer. Number of excluded words in the submitted content.
Overall credits used for the scan.
The creation time of the scan. Timezone: UTC+0.
Show metadata properties
Show metadata properties
The submitted url after all http redirects.
Extracted canonical url from the scanned document.
Publication date of the scanned document.
Creation date of the scanned document.
Last modification date of the scanned document.
Scanned document author.
Scanned document organization.
Scanned document filename.
A list of all the results that were found.
Show results properties
Show results properties
Show internet result properties
Show internet result properties
Unique result ID to identify the result.
Document title. Mostly extracted from the document content.
Document brief introduction. Mostly extracted from the document content.
Unsigned Integer. Total matched words between this result and the scanned document.
Public URL of the resource.
Show metadata properties
Show metadata properties
Final result url after all http redirects.
Extracted canonical url from the result.
Publication date of the result.
Creation date of the result.
Last modification date of the result.
Result author.
Result organization.
Result filename.
Show database result properties
Show database result properties
Unique result ID to identify this result.
Document title. Mostly extracted from the document content.
Document brief introduction.
Unsigned Integer. Total matched words between this result and the scanned document.
In case a result was found in the Copyleaks internal database, and was submitted by you, this will show the scan id of the specific result. Otherwise, this field will remain empty.
Show metadata properties
Show metadata properties
Final result url after all http redirects.
Extracted canonical url from the result.
Publication date of the result.
Creation date of the result.
Last modification date of the result.
Result author.
Result organization.
Result filename.
Show batch result properties
Show batch result properties
Unique result ID to identify this result.
Document title.
Document brief introduction.
Unsigned Integer. Total matched words between this result and the scanned document.
The batch id that is unique for all scans in this batch.
Show metadata properties
Show metadata properties
Final result url after all http redirects.
Extracted canonical url from the result.
Publication date of the result.
Creation date of the result.
Last modification date of the result.
Result author.
Result organization.
Result filename.
Show repository result properties
Show repository result properties
Unique result ID to identify this result.
Document title.
Document brief introduction.
Unsigned Integer. Total matched words between this result and the scanned document.
The repository Id that has the result.
The scanId of the matched results in the repository.
Show metadata properties
Show metadata properties
Final result url after all http redirects.
Extracted canonical url from the result.
Publication date of the result.
Creation date of the result.
Last modification date of the result.
Result author.
Result organization.
Result filename.
Email of the user which added this document to the repository.
Results from the Internal AI Source Match feature, identifying content that matches sources in the Copyleaks internal AI database.
Show internalAIData properties
Show internalAIData properties
Short identifier for the match.
Title of the matched database entry.
Sample excerpt of the matched content.
Total number of words matched from Copyleaks internal AI database.
Number of exactly identical words.
Number of similar but not identical words.
Number of paraphrased words detected.
Total word count in the matched database entry.
The aggregated score of all results.
Show score properties
Show score properties
Unsigned Integer. Number of words which matched exactly.
Unsigned Integer. Number of nearly identical words with small differences like ‘slow’ and ‘slowly’.
Unsigned Integer. Number of paraphrased words showing similar ideas with different words.
Unsigned float. The percentage of similar words from all results. The calculation does not include excluded references, quotations, etc.
A list of all the notifications that were found.
A list of scan alerts that were detected in the scan. See more about Alert Types.
Show alert properties
Show alert properties
Scan alert category.
Scan alert code. The code is unique for each scan alert.
Scan alert human-readable title.
Provides human-readable information about the scan alert.
Url to a resource describing the specific scan alert.
Unsigned Integer. Specifies the importance of the scan alert.Possible values:
0: Very Low1: Low2: Medium3: High4: Very High
Additional data about the scan alert. Supplied as a json string.
Example
{
"status": 0,
"developerPayload": "Custom developer payload",
"scannedDocument": {
"scanId": "string",
"totalWords": 0,
"totalExcluded": 0,
"credits": 0,
"creationTime": "string",
"metadata": {
"finalUrl": "string",
"canonicalUrl": "string",
"author": "string",
"organization": "string",
"filename": "string",
"publishDate": "string",
"creationDate": "string",
"lastModificationDate": "string"
}
},
"results": {
"internet": [
{
"id": "string",
"title": "string",
"introduction": "string",
"matchedWords": 0,
"url": "string",
"metadata": {
"finalUrl": "string",
"canonicalUrl": "string",
"author": "string",
"organization": "string",
"filename": "string",
"publishDate": "string",
"creationDate": "string",
"lastModificationDate": "string"
}
}
],
"database": [
{
"id": "string",
"title": "string",
"introduction": "string",
"matchedWords": 0,
"scanId": "string",
"metadata": {
"finalUrl": "string",
"canonicalUrl": "string",
"author": "string",
"organization": "string",
"filename": "string",
"publishDate": "string",
"creationDate": "string",
"lastModificationDate": "string"
}
}
],
"batch": [
{
"id": "string",
"title": "string",
"introduction": "string",
"matchedWords": 0,
"scanId": "string",
"metadata": {
"finalUrl": "string",
"canonicalUrl": "string",
"author": "string",
"organization": "string",
"filename": "string",
"publishDate": "string",
"creationDate": "string",
"lastModificationDate": "string"
}
}
],
"repositories": [
{
"id": "string",
"title": "string",
"introduction": "string",
"matchedWords": 0,
"repositoryId": "string",
"scanId": "string",
"metadata": {
"finalUrl": "string",
"canonicalUrl": "string",
"author": "string",
"organization": "string",
"filename": "string",
"publishDate": "string",
"creationDate": "string",
"lastModificationDate": "string",
"submittedBy": "string"
}
}
],
"internalAIData": [
{
"id": "string",
"title": "string",
"introduction": "string",
"matchedWords": 0,
"identicalWords": 0,
"similarWords": 0,
"paraphrasedWords": 0,
"totalWords": 0
}
],
"score": {
"identicalWords": 0,
"minorChangedWords": 0,
"relatedMeaningWords": 0,
"aggregatedScore": 0
}
},
"downloadableReport": {
"status": "Success = 0",
"report": "string"
},
"notifications": {
"alerts": [
{
"category": 2,
"code": "string",
"title": "string",
"message": "string",
"helpLink": "string",
"severity": 0,
"additionalData": "string"
}
]
}
}
Next Steps
Webhooks Overview
Learn about the different types of webhooks and how to handle them.
Export Method
Learn how to export scan results, including new plagiarism results.
How to Display Scan Reports
Understand how to present new results to your users effectively.
Scan Alerts
Explore the full list of scan alerts and their meanings.