BOOK A DEMO
LOGIN
Homekeyboard_arrow_rightDocumentationkeyboard_arrow_rightVersion 3keyboard_arrow_rightPlagiarism Checkkeyboard_arrow_rightWebhookskeyboard_arrow_rightCompleted
POST

Completed

The "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 data that is attached to the request body contains the following parts:

Name
Description
status
The current status of the scan.
Integer
Possible values:0 : Success 1 : Error 2 : CreditsChecked 3 : Indexed
developerPayload
The developer payload that was provided in the submit method.
String
Max Length: 512 characters
scannedDocument.scanId
The unique scan id provided by you.
String
scannedDocument.totalWords
Number of copied words from the submitted content.
Unsigned Integer
scannedDocument.totalExcluded
Number of excluded words in the submitted content.
Unsigned Integer
scannedDocument.credits
Overall credits used for the scan.
Integer
scannedDocument.creationTime
The creation time of the scan.
String (datetime)
Timezone: UTC+0
scannedDocument.metadata.finalUrl
The submitted url after all http redirects.
String (uri)
scannedDocument.metadata.canonicalUrl
Extracted canonical url from the scanned document.
String (uri)
scannedDocument.metadata.publishDate
Publication date of the scanned document.
String (datetime)
scannedDocument.metadata.creationDate
Creation date of the scanned document.
String (datetime)
scannedDocument.metadata.lastModificationDate
Last modification date of the scanned document.
String (datetime)
scannedDocument.metadata.author
Scanned document author.
String
scannedDocument.metadata.organization
Scanned document organization.
String
scannedDocument.metadata.filename
Scanned document filename.
String
results.internet.id
Unique result ID to identify the result.
String
results.internet.title
Document title. Mostly extracted from the document content.
String
results.internet.introduction
Document brief introduction. Mostly extracted from the document content.
String
results.internet.matchedWords
Total matched words between this result and the scanned document.
Unsigned Integer
results.internet.url
Public URL of the resource.
String (uri)
results.database.id
Unique result ID to identify this result.
Integer
results.database.title
Document title. Mostly extracted from the document content.
String
results.database.introduction
Document brief introduction. Mostly extracted from the document content.
String
results.database.matchedWords
Total matched words between this result and the scanned document.
Unsigned Integer
results.database.scanId
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.
String
results.batch.id
Unique result ID to identify this result.
String
results.batch.title
Document title. Mostly extracted from the document content.
String
results.batch.introduction
Document brief introduction. Mostly extracted from the document content.
String
results.batch.matchedWords
Total matched words between this result and the scanned document.
Unsigned Integer
results.batch.scanId
The batch id that is unique for all scans in this batch.
String
results.repositories.id
Unique result ID to identify this result.
String
results.repositories.title
Document title. Mostly extracted from the document content.
String
results.repositories.introduction
Document brief introduction. Mostly extracted from the document content.
String
results.repositories.matchedWords
Total matched words between this result and the scanned document.
Unsigned Integer
results.repositories.repositoryId
The repository Id that has the result.
String
results.repositories.scanId
The scanId of the matched results in the repository.
String
results.internet.metadata.finalUrlresults.batch.metadata.finalUrlresults.database.metadata.finalUrl results.repositories.metadata.finalUrl
Final result url after all http redirects.
String (uri)
results.internet.metadata.canonicalUrlresults.batch.metadata.canonicalUrl results.database.metadata.canonicalUrl results.repositories.metadata.canonicalUrl
Extracted canonical url from the result.
String (uri)
results.internet.metadata.publishDateresults.batch.metadata.publishDate results.database.metadata.publishDate results.repositories.metadata.publishDate
Publication date of the result.
String (datetime)
results.internet.metadata.creationDateresults.batch.metadata.creationDate results.database.metadata.creationDate results.repositories.metadata.creationDate
Creation date of the result.
String (datetime)
results.internet.metadata.lastModificationDate results.batch.metadata.lastModificationDate results.database.metadata.lastModificationDate results.repositories.metadata.lastModificationDate
Last modification date of the result.
String (datetime)
results.internet.metadata.authorresults.batch.metadata.authorresults.database.metadata.authorresults.repositories.metadata.author
Result author.
String
results.internet.metadata.organizationresults.batch.metadata.organization results.database.metadata.organization results.repositories.metadata.organization
Result organization.
String
results.internet.metadata.filenameresults.batch.metadata.filenameresults.database.metadata.filename results.repositories.metadata.filename
Result filename.
String
results.repositories.metadata.submittedBy
Email of the user which added this document to the repository.
String
results.score.identicalWords
Number of exact words in the text.
Unsigned Integer
results.score.minorChangedWords
Number of nearly identical words with small differences like 'slow' and 'slowly'.
Unsigned Integer
results.score.relatedMeaningWords
Number of paraphrased words showing similar ideas with different words.
Unsigned Integer
results.score.aggregatedScore
The percentage of similar words from all results. The calculation does not include excluded references, quotations, etc...
Unsigned float
notifications.alerts[]
A list of scan alerts that were detected in the scan.
Object Array
notifications.alerts[].code
Scan alert code. The code is unique for each scan alert.
String
notifications.alerts[].title
Scan alert human-readable title.
String
notifications.alerts[].message
Provides human-readable information about the scan alert.
String
notifications.alerts[].helpLink
Url to a resource describing the specific scan alert.
String
notifications.alerts[].severity
Specifies the importance of the scan alert.
Unsigned Integer
Possible values:
0 : Very Low
1 : Low
2 : Medium
3 : High
4 : Very High
notifications.alerts[].additionalData
Additional data about the scan alert. Supplied as a json string.
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"
        }
      }
    ],
    "score": {
      "identicalWords": 0,
      "minorChangedWords": 0,
      "relatedMeaningWords": 0,
      "aggregatedScore": 0
    }
  },
  "downloadableReport": {
    "status": "Success = 0",
    "report": "string"
  },
  "notifications": {
    "alerts": [
      {
        "code": "string",
        "title": "string",
        "message": "string",
        "helpLink": "string",
        "severity": 0,
        "additionalData": "string"
      }
    ]
  }
}

Other resources:

  • Webhooks Security - Security aspects when protecting your endpoints from unauthorized access.
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.