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

type string

The error type (e.g., authentication_error, payment_error, invalid_request_error, api_error).

id string

The machine-readable error identifier (e.g., invalid_credentials, insufficient_credits).

code integer

Error code that represents the reason for failure. See below the full error table.

message string

Human-readable error message that describes the reason for failure.

url string Optional

A URL to the documentation page for this error.

details array Optional

Additional details about specific parameters that caused the error.

param string

The parameter name that caused the error.

message string

A message describing the issue with this parameter.

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.

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.