Credits Checked

Copyleaks supports a check credits operation. In some cases, you won’t know the exact length of your document, so checking credits first will be helpful to understand how many credits are necessary. Copyleaks allows you to send your document and receive back the amount of credits that the system will require to complete a scan (1 credit = 250 words). To proceed with scanning the document after checking the credits needed, you should call the Start method.

Scans that are not triggered by calling the Start method within 48 hours will be deleted and will no longer be available.

integer

The current status of the scan. Possible values: 0 (Success), 1 (Error), 2 (CreditsChecked), 3 (Indexed)

string

The developer payload that was provided in the submit method.<= 512 characters

integer

The price of the scan. If you will continue scanning, this is the price you will pay.

object

General information about the scanned document.

Show scannedDocument properties

string

The unique scan id provided by you.

integer

Unsigned Integer. Total number of words found in the scanned text.

integer

Unsigned Integer. Number of excluded words in the submitted content.

integer

Overall credits used for the scan.

string<date-time>

The creation time of the scan. Timezone: UTC+0.

object

Show metadata properties

string<uri>

The submitted url after all http redirects.

string<uri>

Extracted canonical url from the scanned document.

string<date-time>

Publication date of the scanned document.

string<date-time>

Creation date of the scanned document.

string<date-time>

Last modification date of the scanned document.

string

Scanned document author.

string

Scanned document organization.

string

Scanned document filename.

Example

{
  "status": 2,
  "developerPayload": "Custom developer payload",
  "credits": 1
}

Next Steps

Start a Scan

Learn how to initiate a scan after checking the credit cost.

Manage Your Credits

Explore strategies for managing your Copyleaks credits effectively.

Webhooks Overview

Learn about the different types of webhooks and how to handle them.

Reference

Actions

Data Types

Example

Next Steps

Start a Scan

Manage Your Credits

Webhooks Overview

​Example

​Next Steps

Start a Scan

Manage Your Credits

Webhooks Overview

Example

Next Steps