GET
/v3/downloads/{scanId}/results/{resultId}
Get access to the raw information of the specific result including the percentage of plagiarism, the exact match’s location in the text, and more. Use this method if you would like to build your own custom-designed report, rather than using the Copyleaks standard report.
Testing purposes only!
This endpoint is for integration testing and verification only. Don't use this endpoint in the production environment.
For the production environment, use the Export method .
For the production environment, use the Export method .
Add this HTTP header to your request: You need to login with a user and api key in order to access this method.
Authorization: Bearer <Your-Login-Token>
Not sure how to generate your login token? Read here .
Request
URL Parameters
Name
Description
scanId
REQUIREDStringLength: 3-36 characters.
resultId
REQUIREDYou will get the result ID through the completed webhook.
String
Request Example
RAW
cURL
Python
C#
Node.js
PHP
GET
https://api.copyleaks.com/v3/downloads/SCAN_ID/results/RESULT_ID
Headers
Body
Response
Codes
Status Code
Description
Example
200
401
Example
{ "statistics": { "identical": 0, "minorChanges": 0, "relatedMeaning": 0 }, "text": { "value": "Hello world!", "pages": { "startPosition": [ 0 ] }, "comparison": { "identical": { "source": { "chars": { "starts": [ 0 ], "lengths": [ 1 ] }, "words": { "starts": [ 0 ], "lengths": [ 1 ] } }, "suspected": { "chars": { "starts": [ 0 ], "lengths": [ 1 ] }, "words": { "starts": [ 0 ], "lengths": [ 1 ] } } }, "minorChanges": { "source": { "chars": { "starts": [ 0 ], "lengths": [ 1 ] }, "words": { "starts": [ 0 ], "lengths": [ 1 ] } }, "suspected": { "chars": { "starts": [ 0 ], "lengths": [ 1 ] }, "words": { "starts": [ 0 ], "lengths": [ 1 ] } } }, "relatedMeaning": { "source": { "chars": { "starts": [ 0 ], "lengths": [ 1 ] }, "words": { "starts": [ 0 ], "lengths": [ 1 ] } }, "suspected": { "chars": { "starts": [ 0 ], "lengths": [ 1 ] }, "words": { "starts": [ 0 ], "lengths": [ 1 ] } } } } }, "html": { "value": "<HTML><body><h3>Hello world!</h3></body></HTML>", "comparison": { "identical": { "groupId": [ 0 ], "source": { "chars": { "starts": [ 0 ], "lengths": [ 1 ] }, "words": { "starts": [ 0 ], "lengths": [ 1 ] } }, "suspected": { "chars": { "starts": [ 0 ], "lengths": [ 1 ] }, "words": { "starts": [ 0 ], "lengths": [ 1 ] } } }, "minorChanges": { "groupId": [ 0 ], "source": { "chars": { "starts": [ 0 ], "lengths": [ 1 ] }, "words": { "starts": [ 0 ], "lengths": [ 1 ] } }, "suspected": { "chars": { "starts": [ 0 ], "lengths": [ 1 ] }, "words": { "starts": [ 0 ], "lengths": [ 1 ] } } }, "relatedMeaning": { "groupId": [ 0 ], "source": { "chars": { "starts": [ 0 ], "lengths": [ 1 ] }, "words": { "starts": [ 0 ], "lengths": [ 1 ] } }, "suspected": { "chars": { "starts": [ 0 ], "lengths": [ 1 ] }, "words": { "starts": [ 0 ], "lengths": [ 1 ] } } } } } }
Description
Name
Description
statistics.identical
Unsigned Integer
statistics.minorChanges
Unsigned Integer
statistics.relatedMeaning
Unsigned Integer
text.value
String
text.pages.startPosition
Integer Array
text.comparison.identical.source.chars.starts
Integer Array
text.comparison.identical.source.chars.lengths
Integer Array
text.comparison.identical.source.words.starts
Integer Array
text.comparison.identical.source.words.lengths
Integer Array
text.comparison.identical.suspected.chars.starts
Integer Array
text.comparison.identical.suspected.chars.lengths
Integer Array
text.comparison.identical.suspected.words.starts
Integer Array
text.comparison.identical.suspected.words.lengths
Integer Array
text.comparison.minorChanges.source.chars.starts
Integer Array
text.comparison.minorChanges.source.chars.lengths
Integer Array
text.comparison.minorChanges.source.words.starts
Integer Array
text.comparison.minorChanges.source.words.lengths
Integer Array
text.comparison.minorChanges.suspected.chars.starts
Integer Array
text.comparison.minorChanges.suspected.chars.lengths
Integer Array
text.comparison.minorChanges.suspected.words.starts
Integer Array
text.comparison.minorChanges.suspected.words.lengths
Integer Array
text.comparison.relatedMeaning.source.chars.starts
Integer Array
text.comparison.relatedMeaning.source.chars.lengths
Integer Array
text.comparison.relatedMeaning.source.words.starts
Integer Array
text.comparison.relatedMeaning.source.words.lengths
Integer Array
text.comparison.relatedMeaning.suspected.chars.starts
Integer Array
text.comparison.relatedMeaning.suspected.chars.lengths
Integer Array
text.comparison.relatedMeaning.suspected.words.starts
Integer Array
text.comparison.relatedMeaning.suspected.words.lengths
Integer Array
html.value
String
html.comparison.identical.groupId
Integer Array
html.comparison.identical.source.chars.starts
Integer Array
html.comparison.identical.source.chars.lengths
Integer Array
html.comparison.identical.source.words.starts
Integer Array
html.comparison.identical.source.words.lengths
Integer Array
html.comparison.identical.suspected.chars.starts
Integer Array
html.comparison.identical.suspected.chars.lengths
Integer Array
html.comparison.identical.suspected.words.starts
Integer Array
html.comparison.identical.suspected.words.lengths
Integer Array
html.comparison.minorChanges.groupId
Integer Array
html.comparison.minorChanges.source.chars.starts
Integer Array
html.comparison.minorChanges.source.chars.lengths
Integer Array
html.comparison.minorChanges.source.words.starts
Integer Array
html.comparison.minorChanges.source.words.lengths
Integer Array
html.comparison.minorChanges.suspected.chars.starts
Integer Array
html.comparison.minorChanges.suspected.chars.lengths
Integer Array
html.comparison.minorChanges.suspected.words.starts
Integer Array
html.comparison.minorChanges.suspected.words.lengths
Integer Array
html.comparison.relatedMeaning.groupId
Integer Array
html.comparison.relatedMeaning.source.chars.starts
Integer Array
html.comparison.relatedMeaning.source.chars.lengths
Integer Array
html.comparison.relatedMeaning.source.words.starts
Integer Array
html.comparison.relatedMeaning.source.words.lengths
Integer Array
html.comparison.relatedMeaning.suspected.chars.starts
Integer Array
html.comparison.relatedMeaning.suspected.chars.lengths
Integer Array
html.comparison.relatedMeaning.suspected.words.starts
Integer Array
html.comparison.relatedMeaning.suspected.words.lengths
Integer Array
Other resources:
- Exponential Backoff - Algorithm that helps applications define a retry strategy for consuming a network service.

Do you have a technical question?
Use stackoverflow.com to get help from our development team and other Copyleaks users.