Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Type

Required

Value

type

String

Yes

RecaptchaV2EnterpriseTaskProxyless

websiteURL

String

Yes

Address of a webpage with Google ReCaptcha Enterprise

websiteKey

String

Yes

Recaptcha website key.
<div class="g-recaptcha" data-sitekey="THAT_ONE"></div>
or <iframe title="reCAPTCHA" src="...;k=6LdIFr0ZAAAAAO3vz0O0OQrtAefzdJcWQM2TMYQH&amp;... , where 6LdIFr0ZAAAAAO3vz0O0OQrtAefzdJcWQM2TMYQH - websiteKey

enterprisePayload

String

No

Some implementations of the reCAPTCHA Enterprise widget may contain additional parameters that are passed to the “grecaptcha.enterprise.render” method along with the sitekey.

For example:

Code Block
grecaptcha.enterprise.render("some-div-id", {
 sitekey: "6Lc_aCMTAAAAABx7u2N0D1XnVbI_v6ZdbM6rYf16",
 theme: "dark",
 s: "2JvUXHNTnZl1Jb6WEvbDyBMzrMTR7oQ78QRhBcG07rk9bpaAaE0LRq1ZeP5NYa0N...ugQA"
 });

apiDomain

String

No

Domain address from which to load reCAPTCHA Enterprise. For example:

Don't use a parameter if you don't know why it's needed.

Request example

Address https://api.capmonster.cloud/createTask

Code Block
{
    "clientKey":"dce6bcbb1a728ea8d871de6d169a2057",
    "task":
    {
        "type":"RecaptchaV2EnterpriseTaskProxyless",
        "websiteURL":"https://mydomain.com/page-with-recaptcha-enterprise",
        "websiteKey":"6Lcg7CMUAAAAANphynKgn9YAgA4tQ2KI_iqRyTwd",
        "enterprisePayload": {
                "s": "SOME_ADDITIONAL_TOKEN"
            }
    }
}

...

Getting result

Use the method getTaskResult to request answer for ReCaptcha2. You will get response within 10 - 80 secs period depending on service workload.

...