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.
integer
The current status of the scan. Possible values:
0 (Success), 1 (Error), 2 (CreditsChecked), 3 (Indexed)string
The developer payload that was provided in the submit method.
<= 512 charactersobject
General information about the scanned document.
Show scannedDocument properties
Show scannedDocument properties
string
The unique scan id provided by you.
integer
Unsigned Integer. Total number of words found in the scanned text.
integer
Unsigned Integer. Number of excluded words in the submitted content.
integer
Overall credits used for the scan.
string<date-time>
The creation time of the scan. Timezone: UTC+0.
object
Show metadata properties
Show metadata properties
string<uri>
The submitted url after all http redirects.
string<uri>
Extracted canonical url from the scanned document.
string<date-time>
Publication date of the scanned document.
string<date-time>
Creation date of the scanned document.
string<date-time>
Last modification date of the scanned document.
string
Scanned document author.
string
Scanned document organization.
string
Scanned document filename.
object
A list of all the results that were found.
Show results properties
Show results properties
array[object]
Show internet result properties
Show internet result properties
string
Unique result ID to identify the result.
string
Document title. Mostly extracted from the document content.
string
Document brief introduction. Mostly extracted from the document content.
integer
Unsigned Integer. Total matched words between this result and the scanned document.
string<uri>
Public URL of the resource.
object
Show metadata properties
Show metadata properties
string<uri>
Final result url after all http redirects.
string<uri>
Extracted canonical url from the result.
string<date-time>
Publication date of the result.
string<date-time>
Creation date of the result.
string<date-time>
Last modification date of the result.
string
Result author.
string
Result organization.
string
Result filename.
array[object]
Show database result properties
Show database result properties
integer
Unique result ID to identify this result.
string
Document title. Mostly extracted from the document content.
string
Document brief introduction.
integer
Unsigned Integer. Total matched words between this result and the scanned document.
string
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.
object
Show metadata properties
Show metadata properties
string<uri>
Final result url after all http redirects.
string<uri>
Extracted canonical url from the result.
string<date-time>
Publication date of the result.
string<date-time>
Creation date of the result.
string<date-time>
Last modification date of the result.
string
Result author.
string
Result organization.
string
Result filename.
array[object]
Show batch result properties
Show batch result properties
string
Unique result ID to identify this result.
string
Document title.
string
Document brief introduction.
integer
Unsigned Integer. Total matched words between this result and the scanned document.
string
The batch id that is unique for all scans in this batch.
object
Show metadata properties
Show metadata properties
string<uri>
Final result url after all http redirects.
string<uri>
Extracted canonical url from the result.
string<date-time>
Publication date of the result.
string<date-time>
Creation date of the result.
string<date-time>
Last modification date of the result.
string
Result author.
string
Result organization.
string
Result filename.
array[object]
Show repository result properties
Show repository result properties
string
Unique result ID to identify this result.
string
Document title.
string
Document brief introduction.
integer
Unsigned Integer. Total matched words between this result and the scanned document.
string
The repository Id that has the result.
string
The scanId of the matched results in the repository.
object
Show metadata properties
Show metadata properties
string<uri>
Final result url after all http redirects.
string<uri>
Extracted canonical url from the result.
string<date-time>
Publication date of the result.
string<date-time>
Creation date of the result.
string<date-time>
Last modification date of the result.
string
Result author.
string
Result organization.
string
Result filename.
string
Email of the user which added this document to the repository.
array[object]
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
string
Short identifier for the match.
string
Title of the matched database entry.
string
Sample excerpt of the matched content.
integer
Total number of words matched from Copyleaks internal AI database.
integer
Number of exactly identical words.
integer
Number of similar but not identical words.
integer
Number of paraphrased words detected.
integer
Total word count in the matched database entry.
object
The aggregated score of all results.
Show score properties
Show score properties
integer
Unsigned Integer. Number of words which matched exactly.
integer
Unsigned Integer. Number of nearly identical words with small differences like ‘slow’ and ‘slowly’.
integer
Unsigned Integer. Number of paraphrased words showing similar ideas with different words.
number<float>
Unsigned float. The percentage of similar words from all results. The calculation does not include excluded references, quotations, etc.
object
A summary of the citation checker results, returned when
references.validate was enabled for the scan. The webhook contains the summary only. The per-reference results, including the parsed citations and corroborating sources, are available in the crawled version.Show referencesValidation properties
Show referencesValidation properties
object
An aggregated count of the references that were detected and validated.
Show summary properties
Show summary properties
integer
The total number of references detected in the scanned content.
integer
The number of detected references that were identified as academic.
integer
The number of academic references that were fully corroborated against the Copyleaks academic citation index.
integer
The number of non-academic references that were fully corroborated against their cited source.
object
A list of all the notifications that were found.
array[object]
A list of scan alerts that were detected in the scan. See more about Alert Types.
Show alert properties
Show alert properties
integer
Scan alert category.
string
Scan alert code. The code is unique for each scan alert.
string
Scan alert human-readable title.
string
Provides human-readable information about the scan alert.
string
Url to a resource describing the specific scan alert.
integer
Unsigned Integer. Specifies the importance of the scan alert.Possible values:
0: Very Low1: Low2: Medium3: High4: Very High
string
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
}
},
"referencesValidation": {
"summary": {
"total": 0,
"academic": 0,
"academicValidated": 0,
"nonAcademicValidated": 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.