Token task · not live yet
reCAPTCHA v3 token API
Get invisible, score-based reCAPTCHA v3 tokens for any page action. Send the URL, site key and action name; submit the token with your request.
reCAPTCHA v3 is coming soon. It is not live yet: today POST /createTask with RecaptchaV3Task returns ERROR_TASK_NOT_SUPPORTED, and nothing is held or charged.
- Planned price / 1,000
- planned—
- Status
- Coming soon
Get notified and we will let you know when reCAPTCHA v3 tasks are accepted. The planned price may change at launch.
Planned interface
What is reCAPTCHA v3?
reCAPTCHA v3 runs in the background and never shows a challenge. Instead it scores each request and the site decides what to allow. The page asks for a token for a named action, such as login or submit, and sends it with the request. bypass.so will return that token.
When it launches, reCAPTCHA v3 will work like the other token types: createTask returns a taskId right away and you poll for the token. The fields below are the planned interface.
RecaptchaV3Task returns the error shown below and nothing is charged. Get notified when it goes live.Request parameters (planned)
| Field | Description |
|---|---|
| clientKeystringrequired | Your API key. You can also send it as Authorization: Bearer <key> instead. |
| typestringrequired | Always RecaptchaV3Task for this task. |
| websiteURLstringrequired | Full URL of the page that requests the token. |
| websiteKeystringrequired | The site key, usually the render= value in the script URL or the first argument of the execute call. |
| actionstringoptional | The action name the page uses, for example login or submit. Match it exactly. Defaults to verify. |
| minScorenumberoptional | Lowest score you want to aim for, such as 0.3, 0.7 or 0.9. Defaults to 0.3. |
{
"errorId": 1,
"errorCode": "ERROR_TASK_NOT_SUPPORTED",
"errorDescription": "reCAPTCHA v3 is coming soon"
}
Response fields (planned)
| Field | Meaning |
|---|---|
| errorId | 0 on success, 1 on error. Errors also carry errorCode and errorDescription. |
| status | processing while the task runs, then ready or failed. |
| taskId | Returned by createTask. Use it to poll and to report a wrong answer. |
| solution.gRecaptchaResponse | The response token. Submit it in the g-recaptcha-response field. |
| solution.tokenField | Name of the form field the token belongs in, when it is known. |
| solution.tokenLifetime | Seconds the token stays usable after it is issued, when it is known. |
Related types
Other task types
Can I send reCAPTCHA v3 tasks today?
POST /createTask with RecaptchaV3Task returns errorId: 1 and ERROR_TASK_NOT_SUPPORTED. No credit is held or charged.What will it cost?
How will I know when it launches?
What can I use today?
What is the action parameter?
login or checkout. Find it in the execute call and send the same string in action.Where do I find the site key?
render=<key>, or as the first argument of the execute call in the page code.Want reCAPTCHA v3 when it launches?
Get notified and we will tell you as soon as reCAPTCHA v3 tasks are accepted. Until then, everything else works with the same key.