Skip to main content
This article will introduce a method for integrating the hCaptcha Protocol Recognition API, which allows users to bypass the identification and clicking of hCaptcha verification images, and instead achieve automatic decoding in the background by simply submitting the Website Key.

​
Application Process

To use hCaptcha Protocol Recognition API, first open the Ace Data Cloud Console and copy your API Token. If you are not logged in, you will be redirected to sign in and brought back to this page automatically. A single API Token works across every service on the platform — no need to subscribe per service. New accounts receive free starter credit; when it runs low you can top up your shared balance in the console.
📘 Full documentation: hCaptcha Protocol Recognition API →

​
Basic Usage

First, understand the basic usage method, which is to input the URL of the website that needs to process the hCaptcha verification code to obtain the processed result. You need to simply pass a website_url field. Our example website is: https://accounts.hcaptcha.com/demo. We need to obtain the website_key from the website_url page. First, open this webpage, press F12 to enter the console, and then perform a global search for hcaptcha-demo in the Elements page. We can get the following result:

The string corresponding to data-sitekey is the value of the website_key. Below are the specific parameter results:

Here we can see that we have set the Request Headers, including:
  • accept: the format of the response result you want to receive, filled in as application/json, which is in JSON format.
  • authorization: the key for calling the API, which can be selected directly after application.
Additionally, the Request Body is set, including:
  • website_url: the URL of the website that needs to process the verification code.
  • website_key: the website key identifier in hCaptcha.
After selection, you can find that the corresponding code is also generated on the right side, as shown in the image below:

Click the “Try” button to conduct a test, as shown in the above image, and we have obtained the following result:
We can see that we have obtained the verification result for processing the hCaptcha verification code, which we can use for POST or simulate submission to the target website, valid for one-time use with a validity period of 120 seconds, and it is recommended to use it within 60 seconds. Next, a CURL version will be provided to submit the processed token to the target website to pass the Recaptcha2 verification. First, we need to understand how the website sends the POST request so that we can pass the generated token into it. We need to open the F12 console and manually go through the verification process. Finally, we can see that the website has sent a POST request, and we only need to check the construction of this POST request. The specific process is as follows:
  • First, manually go through the verification, as shown in the figure below:

  • Then click submit and watch the changes in the console’s network, as shown in the figure below:

  • Analyze the construction of this submitted POST request, and finally right-click on the request to copy the CURL code, as shown in the figure below:

From the analysis of the above figure, we can see that the URL of this POST request is: https://accounts.hcaptcha.com/demo, and we only need to submit the parameters g-recaptcha-response, h-captcha-response, and email. Then we just need to pass the processed token into the data below, and the corresponding CURL code for calling the token verification is as follows:
The corresponding Python code for calling the token verification is as follows:
Then we observe that the console has changed to the following result:

Finally, we have passed the hCaptcha verification. Additionally, if you want to generate the corresponding integration code, you can directly copy it, for example, the CURL code is as follows:
The Python integration code is as follows:

​
Error Handling

When calling the API, if an error occurs, the API will return the corresponding error code and message. For example:
  • 400 token_mismatched: Bad request, possibly due to missing or invalid parameters.
  • 400 api_not_implemented: Bad request, possibly due to missing or invalid parameters.
  • 401 invalid_token: Unauthorized, invalid or missing authorization token.
  • 429 too_many_requests: Too many requests, you have exceeded the rate limit.
  • 500 api_error: Internal server error, something went wrong on the server.

​
Error Response Example

​
Conclusion

Through this document, you have learned how to use the hCaptcha protocol recognition API to allow users to bypass recognizing and clicking on hCaptcha verification code images, simply by submitting the Website Key to achieve automatic decoding in the background and complete the verification. We hope this document can help you better integrate and use this API. If you have any questions, please feel free to contact our technical support team.