Copyleaks supports a price check operation. In some cases, you won’t know the exact length of your document, so using the price check 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.

​
status
integer
The current status of the scan. Possible values: 0 (Success), 1 (Error), 2 (CreditsChecked), 3 (Indexed)
​
developerPayload
string
The developer payload that was provided in the submit method.<= 512 characters
​
credits
integer
The price of the scan. If you will continue scanning, this is the price you will pay.
​
scannedDocument
object
General information about the scanned document.

​
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.