HCaptcha

Create a task through the createTask method, and then get the result through the getTaskResult method

Task Type

Task Type	Description	Price(USD)

Task Type	Description	Price(USD)
HCaptcha	HCaptcha solution	$3.0/k

Create Task

Create a task through the createTask method

Request host： https://api.ez-captcha.com

Request api： https://api.ez-captcha.com/createTask

Request format：POST application/json

Remarks

Currently supported browser versions are: Chrome151

Parameter Structure

Parameter	Type	Required	Description

Parameter	Type	Required	Description
clientKey	string	yes	Your client key
type	string	yes	HCaptcha
websiteURL	string	yes	website url, usually a fixed value.
proxy	string	no	Format: `http://username:password@ip:port` The proxy service supports residential proxies in the United States only.
websiteKey	string	yes	websiteKey, fixed value
lang	string	yes	Currently only supports en-US
invisible	boolean	yes	If the hcap checkbox is not displayed, enter ‘true’; if it is displayed, enter ‘false’.
rqdata	string	no	If present on the website, it must be filled in.

Request Example

POST https://api.ez-captcha.com/createTask

Content-Type: application/json

{
    "clientKey": "YourClientKey",
    "task": {
       "websiteURL": "https://xxx.com",
        "type": "HCaptcha",
        "proxy": "http://username:password@ip:port",
        "lang": "en-US",
        "websiteKey": "e94865c2-4231-4c25-9c6e-2b797b2b56cf",
        "invisible": false
    }
}

Reponse Example

{
    "errorId": 0,
    "errorCode": "",
    "errorDescription": "",
    "taskId": "61138bb6-19fb-11ec-a9c8-0242ac110006" // Please save this ID for next step
}

Get Result

Use the getTaskResult method to get the recognition result

Request host： https://api.ez-captcha.com

Request api： https://api.ez-captcha.com/getTaskResult

Request format：POST application/json

Request Example

POST https://api.ez-captcha.com/getTaskResult

Content-Type: application/json
 
{
    "clientKey":"YOUR_API_KEY",
    "taskId": "TASKID OF CREATETASK" //ID created by createTask method
}

Response Data

Parameter	Type	Description

Parameter	Type	Description
errorId	Integer	Error message: 0 - no error, 1 - error
errorCode	string	Error code, click here to view all error list
errorDescription	string	Detailed error description
status	String	processing - task is in progress, please try again in 3 seconds ready - task is complete, find the result in the solution parameter
solution	Object	The recognition result will be different for different types of captcha. For reCaptcha, the result is gRecaptchaResponse in the object.

Response Example

{
    "errorId": 0,
    "errorCode": null,
    "errorDescription": null,
    "solution": {
      {
        "generated_pass_UUID": "xxxxxx",
        "lang": "en-US",
        "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/147.0.0.0 Safari/537.36"
      }
    },
    "status": "ready"
}

Response Description

Successful recognition: when errorId is equal to 0 and status is equal to ready, the result is in the solution.
Identifying: When errorId is 0 and status is processing, please try again after 3 seconds.
An error occurred: when the errorId is greater than 0, please understand the error information according to the errorDescription All error descriptions