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. 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": [1] },
        "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": [2] },
        "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 }
          }
        ]
      }
    ]
  }
}

Citations Cross-Check

When references.crossCheck is enabled, referencesValidation also includes a citationsCrossCheck object. It checks that every in-text citation has an entry in the reference list, and that every entry in the reference list is cited in the text.

object

Returned when references.crossCheck is enabled. Compares the in-text citations with the reference list, in both directions. It is null (or absent) when cross-check was not requested, when no reference list was found, or when the reference list has more than 200 entries.

Show citationsCrossCheck properties

object

Headline counts for both directions of the check.

Show summary properties

string

The citation style detected in the document.Available Options:

authorYear - Author-date citations such as (Smith, 2020) or Smith (2020). Cross-checked.
numeric - Numbered citations such as [1] or [2-4]. Cross-checked.
footnote - Footnote or endnote citations. Detected but not cross-checked, so no citation is flagged.
none - No in-text citations were found.

object

Counts for the in-text citations.

Show citations properties

integer

Number of in-text citations found.

integer

Citations that point to an entry in the reference list.

integer

Citations with no entry in the reference list.

integer

Citations that need a human look, usually because the cited year does not match the entry by that author.

object

Counts for the reference list entries that were checked.

Show references properties

integer

Number of reference entries checked. Is 0 when the document has fewer than 3 in-text citations.

integer

Entries cited at least once in the text.

integer

Entries never cited in the text.

integer

Entries that need a human look.

array[object]

One entry per cited work, in the order the citations appear in the document. A group such as (Smith, 2020; Lee, 2019) produces one entry per work, and the entries share the same text range.

Show citation item properties

integer

Index of the citation in this array. Referenced by citedBy in the references array.

object

Position of the citation in the extracted text. starts and lengths are parallel arrays.

Show textRanges properties

array[integer]

Start positions of the citation in the extracted text.

array[integer]

Lengths of each spanned section.

object

Position of the citation in 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 of each spanned section.

array[integer]

Identifiers that group the spans belonging to one citation.

string

The citation exactly as it appears in the text, for example (Kim & Park, 2020).

object

What Copyleaks read from the citation.

Show parsed properties

array[string]

The cited author or organization names. Empty for numeric citations.

integer

The cited year. Omitted for numeric citations and for citations without a year, such as (Smith, n.d.).

integer

The cited number. Present for numeric citations only.

boolean

true when the citation points to an entry in the reference list.

boolean

true when the citation needs a human look. When both matched and needsReview are false, the citation has no entry in the reference list.

integer

Index of the linked entry in referencesValidation.results. Set for matched citations and, in most cases, for citations that need review. Omitted when there is no single entry to point to, for example when the citation has no entry in the reference list.

array[object]

One entry per reference list entry that was checked. Entries without a recognizable author are not checked and are left out, so this array can be shorter than referencesValidation.results. Empty when the document has fewer than 3 in-text citations.

Show reference item properties

integer

Index of the entry in referencesValidation.results.

boolean

true when at least one citation in the text matches this entry.

boolean

true when the entry needs a human look. When both matched and needsReview are false, the entry is never cited in the text.

array[integer]

The id of every citation linked to this entry, including citations that need review. Empty when the entry is never cited.

How to read the results

Each citation and each checked reference gets one of three outcomes, read from its matched and needsReview fields:

Outcome	Citation (`citations[]`)	Reference entry (`references[]`)
`matched: true`	The citation points to an entry in the reference list.	The entry is cited at least once in the text.
`needsReview: true`	An entry by the same author exists but the year does not match, the citation is secondary (for example “as cited in”), or it cannot be tied to a single entry.	The entry is linked only to citations that need review, or its author is mentioned in the text without a formal citation.
both `false`	The citation has no entry in the reference list.	The entry is never cited in the text.

matchedReferenceId and referenceId are indexes into referencesValidation.results, so you can open the full validation result of the linked entry. citedBy lists citation id values, so you can jump from an entry to every place it is cited.

Citations cross-check example

The document below cites (Smith, 2020), (Kim & Park, 2020) and (Patel, 2021), and its reference list holds Brown (2017), Kim & Park (2021) and Smith (2020). Smith is cited correctly, Kim & Park is cited with the wrong year, Patel has no entry, and Brown is never cited. The summary and results of referencesValidation are left out of the example.

{
  "referencesValidation": {
    "citationsCrossCheck": {
      "summary": {
        "style": "authorYear",
        "citations": { "total": 3, "matched": 1, "notMatched": 1, "needsReview": 1 },
        "references": { "total": 3, "cited": 1, "notCited": 1, "needsReview": 1 }
      },
      "citations": [
        {
          "id": 0,
          "textRanges": { "starts": [85], "lengths": [13] },
          "htmlRanges": { "starts": [], "lengths": [], "groupIds": [] },
          "raw": "(Smith, 2020)",
          "parsed": { "names": ["Smith"], "year": 2020 },
          "matched": true,
          "needsReview": false,
          "matchedReferenceId": 2
        },
        {
          "id": 1,
          "textRanges": { "starts": [138], "lengths": [18] },
          "htmlRanges": { "starts": [], "lengths": [], "groupIds": [] },
          "raw": "(Kim & Park, 2020)",
          "parsed": { "names": ["Kim", "Park"], "year": 2020 },
          "matched": false,
          "needsReview": true,
          "matchedReferenceId": 1
        },
        {
          "id": 2,
          "textRanges": { "starts": [196], "lengths": [13] },
          "htmlRanges": { "starts": [], "lengths": [], "groupIds": [] },
          "raw": "(Patel, 2021)",
          "parsed": { "names": ["Patel"], "year": 2021 },
          "matched": false,
          "needsReview": false
        }
      ],
      "references": [
        { "referenceId": 0, "matched": false, "needsReview": false, "citedBy": [] },
        { "referenceId": 1, "matched": false, "needsReview": true, "citedBy": [1] },
        { "referenceId": 2, "matched": true, "needsReview": false, "citedBy": [0] }
      ]
    }
  }
}

Reference

Actions

Data Types

Webhook HTTP verb

Example

Citation Checker

Validation semantics

References validation example

Citations Cross-Check

How to read the results

Citations cross-check example

Next Steps

Export Method

How to Display Scan Reports

​Webhook HTTP verb

​Example

​Citation Checker

​Validation semantics

​References validation example

​Citations Cross-Check

​How to read the results

​Citations cross-check example

​Next Steps

Export Method

How to Display Scan Reports

Webhook HTTP verb

Example

Citation Checker

Validation semantics

References validation example

Citations Cross-Check

How to read the results

Citations cross-check example

Next Steps