The scannedDocument object provides metadata and information about a scan that has been submitted to the Copyleaks API.

scanId string

The unique identifier for the scan that you provided during submission.

totalWords integer

The total number of words detected in the submitted content.

totalExcluded integer

The total number of words that were excluded from the scan based on your exclude settings.

credits integer

The number of credits consumed by the scan. This will be 0 until the scan is completed.

expectedCredits integer

The number of credits that are expected to be consumed by the scan upon completion.

creationTime string

The Coordinated Universal Time (UTC) timestamp indicating when the scan was created. Format: YYYY-MM-DDTHH:mm:ss.sssssssZ

metadata object

An object containing metadata about the submitted file. For example, it can contain the filename.

enabled object

An object indicating which scan features were enabled for this scan.

plagiarismDetection boolean

Indicates if plagiarism detection was enabled.

aiDetection boolean

Indicates if AI-generated text detection was enabled.

explainableAi boolean

Indicates if the AI Logic (explainable AI) feature was enabled.

writingFeedback boolean

Indicates if the Writing Assistant feature was enabled.

pdfReport boolean

Indicates if the generation of a PDF report was enabled.

cheatDetection boolean

Indicates if cheat detection was enabled.

aiSourceMatch boolean

Indicates if AI source matching was enabled.

detectedLanguage string

The language code (ISO 639-1) of the language detected in the submitted content.