RecaptchaV3EnterpriseTask: enterprise version of reCaptcha V3 protocol interface
To create a recognition task using the createTask
method and obtain the recognition result using the getTaskResult
method.
We can only use the enterprise version API to recognize if the target website is using the enterprise version reCaptcha.
Links that contain the keywords "api.js" and "recaptcha", and have "enterprise" in the URL, generally refer to the enterprise version.
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
Object Structure
Parameter | Type | Required | Purpose |
---|---|---|---|
type | string | Yes | RecaptchaV3EnterpriseTask 20 POINTS RecaptchaV3EnterpriseTaskM1 25 POINTS RecaptchaV3EnterpriseTaskT1 40 POINTS *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" : "RecaptchaV3EnterpriseTask"
}
}
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
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