The error event happens as soon as the scan process reaches an end due to an error.
​
status
integer
The current status of the scan. Possible values: 0 (Success), 1 (Error), 2 (CreditsChecked), 3 (Indexed)
​
error
object
​
developerPayload
string
The developer payload that was provided in the submit method.<= 512 characters
Copyleaks provides you with the specific error message describing the reason for the error. Some of the failures are related to incorrect configuration on your side. Others are related to Copyleaks server-side errors. We are doing our best to successfully respond to all of your requests. Still, sometimes we encounter an internal error. In that case, we will fix the problem as soon as possible. You will also get a unique ticket ID that will help identify the problem when contacting Copyleaks customer support. For a complete reference of all the error codes and how to handle them, see API Errors.

​
Example

{
  "status": 1,
  "error": {
    "type": "invalid_request_error",
    "id": "missing_parameter",
    "code": 1,
    "message": "Bad request. One or several required parameters are missing or incorrect."
  },
  "developerPayload": "Custom developer payload"
}

​
Next Steps

Error Codes

Complete reference of all API error codes and how to resolve them.

Webhooks Overview

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

Handling Failures

Understand how to implement an exponential backoff strategy for retrying requests.

Scan Alerts

Explore the full list of scan alerts and their meanings.