Crawled Version

A snapshot of the submitted document. It shows how Copyleaks viewed your submitted file.

Webhook HTTP verb

The HTTP verb for this webhook is upon developer request. You need to specify your verb while executing the Export method See crawledVersion.verb field.

We recommend you use the HTTP verb PUT. It will allow Copyleaks to override an existing file as needed.

The crawled version is available in textual format, and if the properties.includeHtml field (in the submit method) is set to true, it is also in HTML format.

object

Show metadata properties

integer

Number of words in the text.

integer

Number of excluded words in the text.

object

Show text properties

string

The crawled version of the submitted text.

object

Show exclude properties

array

The start position of the section to exclude.

array

The length, in characters, of the section to exclude.

array

The reason why this section was excluded.

object

Show pages properties

array

A list of pages start positions of the text.

Example

{
  "metadata": {
    "words": 30,
    "excluded": 2
  },
  "html": {
    "value": "<html><body><h1>Example Domain</h1><p>This domain is established to be used for illustrative examples in documents.</body></html>",
    "exclude": {
      "starts": [
        16
      ],
      "lengths": [
        14
      ],
      "reasons": [
        3
      ],
      "groupIds": [
        1
      ]
    }
  },
  "text": {
    "value": "Example Domain This domain is established to be used for illustrative examples in documents.",
    "exclude": {
      "starts": [
        0
      ],
      "lengths": [
        14
      ],
      "reasons": [
        3
      ]
    },
    "pages": {
      "startPosition": [
        0
      ]
    }
  }
}

Citation Checker

When references.validate is enabled, the crawled version includes a referencesValidation object with the validation summary and a results array (one entry per detected reference).

object

Aggregated counts for the references that were detected and validated in the document.

Show summary properties

integer

Total number of references detected in the document.

integer

How many of the detected references were classified as academic.

integer

Number of academic references that were fully corroborated.

integer

Number of non-academic references that were fully corroborated.

array[object]

One entry per detected reference, with what Copyleaks parsed from the citation, where it appears in the document, and the corroborating sources that were found.

Show result item properties

string

Whether the reference was validated as academic or non-academic.Available Options:

academic - Validated against the Copyleaks academic citation index.
nonAcademic - Validated by fetching the cited URL and comparing the page to the citation.

object

Character offsets of the citation in the extracted text. starts and lengths are parallel arrays: starts[i] pairs with lengths[i].

Show textRanges properties

array[integer]

Start positions of the citation in the extracted text.

array[integer]

Lengths, in characters, of each spanned section.

object

Positions of the citation mapped into the rendered HTML report, used for highlighting. Empty ([]) for plain-text (.txt) scans that have no HTML layout.

Show htmlRanges properties

array[integer]

Start positions of the citation in the rendered HTML.

array[integer]

Lengths, in characters, of each spanned section.

array[integer]

Identifiers that group the spans belonging to a single citation.

object

The structured fields Copyleaks parsed out of the user’s citation.

Show parsed properties

string

The cited title.

array[string]

The cited authors.

integer

The cited year. This stays a single value, unlike the published and modified years reported on a suggestion.

string

The cited journal or publication. May be an empty string.

string

The cited link. Present for non-academic references.

array[object]

The corroborating source(s) found for the reference. Empty if none were found.

Show suggestion properties

string

URL of the corroborating source.

string

DOI of the corroborating source. May be an empty string.

string

Title of the corroborating source.

array[string]

Authors of the corroborating source.

integer

The source’s publication year. Optional, omitted if unknown.

integer

The source’s last-modified year. Optional, omitted if unknown.

string

Journal or publication of the corroborating source. May be an empty string.

object

Which of the parsed fields this suggestion corroborates. A signal that is omitted was not checked and does not count against the reference.

Show signals properties

boolean

Whether the parsed title matches the suggestion.

boolean

Whether the cited year is corroborated. Optional, omitted if not checked. The match is strict and either-or: the cited year counts only if it equals the suggestion’s publishedYear or its modifiedYear. A cited year that merely falls between the two does not corroborate and is treated as a mismatch.

boolean

Whether the parsed authors match the suggestion. Optional, omitted if not checked.

Validation semantics

A reference is counted in academicValidated or nonAcademicValidated only when it is fully corroborated: the top suggestion matched the title and no checked signal is false. A signal that is absent or null is ignored, not held against the reference.

A suggestion with signals of { "title": true } only, with no year or authors checked, counts as validated.
A suggestion with { "title": true, "year": false, "authors": false } does not count as validated.

References validation example

{
  "referencesValidation": {
    "summary": {
      "total": 2,
      "academic": 1,
      "academicValidated": 1,
      "nonAcademicValidated": 0
    },
    "results": [
      {
        "type": "academic",
        "textRanges": { "starts": [131], "lengths": [131] },
        "htmlRanges": { "starts": [240], "lengths": [131], "groupIds": [0] },
        "parsed": {
          "title": "Attention Is All You Need",
          "authors": ["Vaswani, A.", "Shazeer, N.", "Parmar, N."],
          "year": 2017,
          "journal": "Advances in Neural Information Processing Systems"
        },
        "suggestions": [
          {
            "url": "https://doi.org/10.48550/arXiv.1706.03762",
            "doi": "10.48550/arXiv.1706.03762",
            "title": "Attention Is All You Need",
            "authors": ["Vaswani, A.", "Shazeer, N.", "Parmar, N.", "Uszkoreit, J."],
            "publishedYear": 2017,
            "modifiedYear": 2023,
            "journal": "Advances in Neural Information Processing Systems",
            "signals": { "title": true, "year": true, "authors": true }
          }
        ]
      },
      {
        "type": "nonAcademic",
        "textRanges": { "starts": [500], "lengths": [100] },
        "htmlRanges": { "starts": [620], "lengths": [100], "groupIds": [1] },
        "parsed": {
          "url": "https://en.wikipedia.org/wiki/Artificial_intelligence",
          "title": "Artificial intelligence",
          "authors": ["Wikipedia"],
          "year": 2024,
          "journal": ""
        },
        "suggestions": [
          {
            "url": "https://en.wikipedia.org/wiki/Artificial_intelligence",
            "doi": "",
            "title": "Artificial intelligence - Wikipedia",
            "authors": ["Contributors to Wikimedia projects"],
            "publishedYear": 2001,
            "modifiedYear": 2026,
            "journal": "",
            "signals": { "title": true, "year": false, "authors": false }
          }
        ]
      }
    ]
  }
}

Reference

Actions

Data Types

Webhook HTTP verb

Example

Citation Checker

Validation semantics

References validation example

Next Steps

Export Method

How to Display Scan Reports

​Webhook HTTP verb

​Example

​Citation Checker

​Validation semantics

​References validation example

​Next Steps

Export Method

How to Display Scan Reports

Webhook HTTP verb

Example

Citation Checker

Validation semantics

References validation example

Next Steps