Coming soon

Token task · not live yet

hCaptcha token API

Send the page URL and site key, and get back a ready-to-submit hCaptcha token, with no image grids to click through.

hCaptcha is coming soon. It is not live yet: today POST /createTask with HCaptchaTask returns ERROR_TASK_NOT_SUPPORTED, and nothing is held or charged.

Planned price / 1,000
planned—
Status
Coming soon
Get notified See live types

Get notified and we will let you know when hCaptcha tasks are accepted. The planned price may change at launch.

Planned interface

What is hCaptcha?

hCaptcha shows a checkbox and, when it is unsure, an image-grid challenge. A passed check writes a response token into a hidden field that the site verifies on submit. bypass.so will return that token for you to submit.

When it launches, hCaptcha 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.

POST/createTask
GET/getTaskResult/{taskId}
POST/reportBad?task_id={taskId}
Not live yet. Until launch, createTask with HCaptchaTask returns the error shown below and nothing is charged. Get notified when it goes live.

Request parameters (planned)

FieldDescription
clientKeystringrequiredYour API key. You can also send it as Authorization: Bearer <key> instead.
typestringrequiredAlways HCaptchaTask for this task.
websiteURLstringrequiredFull URL of the page that shows the widget.
websiteKeystringrequiredThe site key: the data-sitekey attribute of the widget, a UUID-style string.
Planned request · POST /createTask






Today · POST /createTask


{
  "errorId": 1,
  "errorCode": "ERROR_TASK_NOT_SUPPORTED",
  "errorDescription": "hCaptcha is coming soon"
}






Response fields (planned)


FieldMeaning


errorId0 on success, 1 on error. Errors also carry errorCode and errorDescription.


statusprocessing while the task runs, then ready or failed.


taskIdReturned by createTask. Use it to poll and to report a wrong answer.


solution.tokenThe response token. Submit it in the h-captcha-response field.


solution.tokenFieldName of the form field the token belongs in, when it is known.


solution.tokenLifetimeSeconds the token stays usable after it is issued, when it is known.























Related types
Other task types

All types
















FAQ
hCaptcha questions
More answers in the general FAQ.




Can I send hCaptcha tasks today?
Not yet. Until launch, POST /createTask with HCaptchaTask returns errorId: 1 and ERROR_TASK_NOT_SUPPORTED. No credit is held or charged.


What will it cost?
The planned price is — per 1,000 solved tasks. As with every type, you will pay only for solved tasks. We will confirm the final price at launch.


How will I know when it launches?
Use the Get notified form and we will let you know once hCaptcha tasks are accepted.


What can I use today?
Math, image to text, audio, reCAPTCHA v2 and Cloudflare Turnstile are live now, with the same key and endpoints. See all task types.


Where is the site key?
On the widget element as data-sitekey. It looks like a UUID, for example 10000000-ffff-ffff-ffff-000000000001.


Which field does the token go in?
The hidden h-captcha-response textarea. Many pages also include a g-recaptcha-response field for compatibility; fill it with the same token.








Want hCaptcha when it launches?
Get notified and we will tell you as soon as hCaptcha tasks are accepted. Until then, everything else works with the same key.


Get notifiedSee live types