To create a recognition task using the createTask
method and obtain the recognition result using the getTaskResult
method.
This object is used for recognizing reCaptchaV2 versions.
Create Tasks
To create a recognition task using the createTask
method.
Request node: INTERNATIONAL NODE https://api.yescaptcha.com
CHINA NODE https://cn.yescaptcha.com
Method address:: https://api.yescaptcha.com/createTask
Request format:POST
application/json
Example Structure
Parameters | Type | Required | Purpose |
---|---|---|---|
type | string | Yes | NoCaptchaTaskProxyless 15 POINTS DEFAULT RecaptchaV2TaskProxyless 20 POINTS ->18 POINTS HIGHER QUALITY MORE STABLE |
websiteURL | string | Yes | The address of the ReCaptcha web page.Fixed value.🔗 How to find the value of websiteURL? |
websiteKey | String | Yes | The ReCaptcha website key. Fixed value.🔗 How to find the value of websiteKey? |
isInvisible | Bool | No | If you encounter a reCaptchaV2 of |
Request Example
{ "clientKey": "cc9c18d3e263515c2c072b36a7125eecc078618f", "task": { "websiteURL": "https://www.google.com/recaptcha/api2/demo", "websiteKey": "6Le-wvkSAAAAAPBMRTvw0Q4Muexq9bi0DJwx_mJ-", "type": "NoCaptchaTaskProxyless", "isInvisible": false // You only need to add the true value if the reCaptcha type is isInvisible. } }
Response Example
{ "errorId": 0, "errorCode": "", "errorDescription": "", "taskId": "61138bb6-19fb-11ec-a9c8-0242ac110006" // Please keep a record of this ID. }
Get the Result
To obtain the recognition result using the getTaskResult
method.
Request node: INTERNATIONAL NODE https://api.yescaptcha.com
CHINA NODE https://cn.yescaptcha.com
Request address: https://api.yescaptcha.com/getTaskResult
Request format:POST
application/json
Based on the system load, you will receive the result within a time interval of 10s to 80s, with a timeout of 120 seconds.
Request Example
{ "clientKey":"cc9c18d3e263515c2c072b36a7125eecc078618f3", "taskId": "61138bb6-19fb-11ec-a9c8-0242ac110006" }
Response Result
Parameters | Type | Purpose |
---|---|---|
errorId | Integer | Error message: 0 - No error, 1 - Error |
errorCode | string | Error code.Check out🔗 errors list. |
errorDescription | string | Error description |
status | String | processing - task is not ready yet. |
solution | Object | Task result data. Different for each type of task. |
gRecaptchaResponse | string | Recognition result: The The |
Response Example
{ "errorId": 0, "errorCode": null, "errorDescription": null, "solution": { "gRecaptchaResponse": "03AGdBq25SxXT-pmSeBXjzScW-EiocHwwpwqtk1QXlJnGnU......" }, "status": "ready" }
Response Description
Recognition succeeded: If
errorId
= 0 andstatus
isready
, the result is in thesolution
field.Recognition in progress: If
errorId
= 0 andstatus
isprocessing
, please retry after 3 seconds.Error occurred: If
errorId
> 0, please refer toerrorDescription
to learn more about the error message. 🔗 Error Types
FAQ: