Error Handling
It's very important to use proper error handling in your code to avoid suspension of your account and service interruption.
Normally if something is wrong with your request server will return an error.
Below you can find tables with lists of errors with descriptions:
Errors can be returned as plain text or as JSON if you provided json=1 parameter.
In very rare cases server can return HTML page with error text like 500 or 502 - please keep it in mind and handle such cases correctly.
If you received anything that doesn't looks like the answer or error code - make a 5 seconds timeout and then retry your request.
List of in.php errors
| Error code | Description | Action |
|---|---|---|
| ERROR_WRONG_USER_KEY | You've provided key parameter value in incorrect format, it should contain 32 symbols. | Stop sending requests. Check your API key. |
| ERROR_KEY_DOES_NOT_EXIST | The key you've provided does not exists. | Stop sending requests. Check your API key. |
| ERROR_ZERO_BALANCE | You don't have free threads. | Send less captchas at a time or upgrade your plan. |
| ERROR_PAGEURL | pageurl parameter is missing in your request. | Stop sending requests and change your code to provide valid pageurl parameter. More info. |
| ERROR_ZERO_CAPTCHA_FILESIZE | Image size is less than 100 bytes. | Check the image file. |
| ERROR_TOO_BIG_CAPTCHA_FILESIZE | Image size is more than 100 kB. | Check the image file. |
| ERROR_WRONG_FILE_EXTENSION | Image file has unsupported extension. Accepted extensions: jpg, jpeg, gif, png. | Check the image file. |
| ERROR_IMAGE_TYPE_NOT_SUPPORTED | Server can't recognize image file type. | Check the image file. |
| ERROR_UPLOAD | Server can't get file data from your POST-request. That happens if your POST-request is malformed or base64 data is not a valid base64 image. | You got to fix your code that makes POST request. |
| IP_BANNED | Your IP address is banned due to many frequent attempts to access the server using wrong authorization keys. | Ban will be automatically lifted after 5 minutes. |
| ERROR_BAD_TOKEN_OR_PAGEURL | You can get this error code when sending reCAPTCHA V2. That happens if your request contains invalid pair of googlekey and pageurl. The common reason for that is that reCAPTCHA is loaded inside an iframe hosted on another domain/subdomain. | Explore code of the page carefully to find valid pageurl and sitekey values. |
| ERROR_GOOGLEKEY | You can get this error code when sending reCAPTCHA V2. That means that sitekey value provided in your request is incorrect: it's blank or malformed. | Check your code that gets the sitekey and makes requests to our API. |
| ERROR_WRONG_GOOGLEKEY | googlekey parameter is missing in your request | Check your code that gets the sitekey and makes requests to our API. |
| ERROR_CAPTCHAIMAGE_BLOCKED | You've sent an image that is marked in our database as unrecognizable. Usually that happens if the website where you found the captcha stopped sending you captchas and started to send "deny access" image. | Try to override website's limitations. |
| ERROR_BAD_PARAMETERS | The error code is returned if some required parameters are missing in your request or the values have incorrect format. | Check that your request contains all the required parameters and the values are in proper format. |
| ERROR_BAD_PROXY | You can get this error code when sending a captcha via proxy server which ismarked as BAD by our API. | Use a different proxy server in your requests. |
| ERROR_SERVER_ERROR | Something went worng with our server. | Try again after 10 seconds. |
| ERROR_INTERNAL_SERVER_ERROR | Something went worng with our captcha processing servers. | Try again after 10 seconds. |
List of res.php errors
| Error code | Description | Action |
|---|---|---|
| CAPCHA_NOT_READY | Your captcha is not solved yet. | Make 5 seconds timeout and repeat your request. |
| ERROR_CAPTCHA_UNSOLVABLE | We are unable to solve your captcha it may be not supported. | Check if supported & you can retry to send your captcha. |
| ERROR_WRONG_USER_KEY | You've provided key parameter value in incorrect format, it shouldcontain 32 symbols. | Stop sending requests. Check your API key. |
| ERROR_KEY_DOES_NOT_EXIST | The key you've provided does not exists. | Stop sending requests. Check your API key. |
| ERROR_WRONG_ID_FORMAT | You've provided captcha ID in wrong format. The ID can contain numbers only. | Check the ID of captcha or your code that gets the ID. |
| ERROR_WRONG_CAPTCHA_ID | You've provided incorrect captcha ID. | Check the ID of captcha or your code that gets the ID. |
| ERROR_EMPTY_ACTION | Action parameter is missing or no value is provided for action parameter. | Check your request parameters and add the neccessary value, e.g. get or getbalance. |
| ERROR_PROXY_CONNECTION_FAILED | You can get this error code if we were unable to load a captcha through your proxy server. The proxy will be marked as BAD by our API and we will not accept requests with the proxy during 10 minutes. You will recieve ERROR_BAD_PROXY code from in.php API endpoint in such case. | Use a different proxy server in your requests. |
| ERROR_INTERNAL_SERVER_ERROR | Something went worng with our captcha processing servers. | Try again after 10 seconds. |