查看来源

To create a recognition task using the createTask method and obtain the recognition result using the getTaskResult method.

In contrast to reCaptcha V2, reCaptcha V3 is a non-intrusive verification method that requires an additional pageAction field value to be added (optionally).

Create Tasks

To create a recognition task using the createTask method.

Request node： https://api.yescaptcha.com 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	RecaptchaV3TaskProxyless RecaptchaV3TaskProxylessM1 RecaptchaV3TaskProxylessK1 RecaptchaV3EnterpriseTaskProxylessK1 *If the above types cannot pass the verification for your website, you can contact customer service to customize an API for you.
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?
pageAction	String	No	This value must be correct, otherwise the recognition result is invalid.How to find the necessary parameters for Google reCaptcha

Request Example

{
    "clientKey": "cc9c18d3e263515c2c072b36a7125eecc078618f",
    "task": {
        "websiteURL" : "https://www.toysrus.co.jp/member/CMmMemberForm.jsp",
        "websiteKey" : "6LdJXmobAAAAAFLNEpWqZrAXDr4I3l2lFyMLdqoM",
        "pageAction" : "homepage", // not required
        "type" : "RecaptchaV3TaskProxyless"
    }
}

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： https://api.yescaptcha.com 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. ready - task complete, solution object can be found in solution property.
solution	Object	Task result data. Different for each type of task.
gRecaptchaResponse	string	Recognition result: The `response` value, which is used to make a POST or simulated submission to the target website. The `response` value is for one-time use only and is valid for 120 seconds. We recommend using it within 60 seconds. How to pass Google reCaptcha using the API

Response Example

{
    "errorId": 0,
    "errorCode": null,
    "errorDescription": null,
    "solution": {
        "gRecaptchaResponse": "03AGdBq25SxXT-pmSeBXjzScW-EiocHwwpwqtk1QXlJnGnU......"
    },
    "status": "ready"
}

Response Description

Recognition succeeded: If errorId = 0 and status is ready, the result is in the solution field.
Recognition in progress: If errorId = 0 and status is processing, please retry after 3 seconds.
Error occurred: If errorId > 0, please refer to errorDescription to learn more about the error message. Error Types

FAQ:

The results returned by the API may not always be 100% successful in verification, as the success rate varies depending on the website.
The website may have a score threshold, and if the score is lower than the threshold, the verification will fail.
The website may adjust the score threshold at any time.
The requirements for reCaptcha V3 are high, so if your website has even a small chance of passing, it is already quite good.
There is no other way around this.