PRODUCT TEST WORKSPACE

reCAPTCHA v3 Enterprise

Captcha verification product

RECAPTCHA_V3_ENTERPRISE

02 / REQUEST

Request preview

POST /api/validator/create.cgi

{
  "productCode" : "RECAPTCHA_V3_ENTERPRISE",
  "adapter" : {
    "websiteURL" : "https://example.com/register",
    "websiteKey" : "YOUR_WEBSITEKEY",
    "minScore" : 0.3
  }
}

03 / RESULT

Response example

EXAMPLE

Task ID —

{
  "code" : 0,
  "msg" : "Success",
  "data" : {
    "taskId" : "11111111-1111-4111-8111-111111111111",
    "productCode" : "RECAPTCHA_V3_ENTERPRISE",
    "state" : "SUCCEEDED",
    "solution" : {
      "gRecaptchaResponse" : "EXAMPLE_GRECAPTCHARESPONSE",
      "token" : "EXAMPLE_TOKEN"
    }
  }
}

Illustrative response; not a live task result. Replace all request placeholders before submitting.

Read data.solution after state becomes SUCCEEDED. The solution fields depend on the product; other states may return an empty object.

04 / API REFERENCE

reCAPTCHA v3 Enterprise · API

For task creation and queries, send the API key in the apiKey HTTP header. JSON request bodies contain business parameters only.

Content-Type: application/json
apiKey: YOUR_API_KEY

Result and application

TOKEN

Use the v3 token with the target site key, minScore and actual pageAction. RECAPTCHA_V3_ENTERPRISE always uses Enterprise mode. This integration remains proxyless; v2 session fields (enterprisePayload, recaptchaDataSValue, cookies and proxy fields) are not exposed for v3. Do not infer score requirements or target acceptance from an image challenge.

Conditional workflows

HTTP submission HTTP_SUBMIT
Apply a result in the browser BROWSER_RESULT

Requirements

Prefer the product-specific (native) CAPTCHA integration over generic GRID. Identify the actual product/version and read its schema/guide before choosing. Use HTTP_SUBMIT when the target supports it, otherwise BROWSER_RESULT when the browser can apply the native result. Image grids on screen do not by themselves mean the product is GRID. Collect real inputs; missing inputs are a blocker, not permission to guess.
Apply a native result through the matching target integration: fill the expected token response field/callback, or use the returned challenge identifier and proof/answer fields together where that product requires them. Preserve the target session and bindings. Do not mix old and new challenge fields, replace only a picture, or assume the solver issues an unrelated transferable challenge/answer pair.
Identify v2 checkbox/invisible versus v3 score execution and ordinary versus Enterprise before creating. enterprise.js alone does not distinguish Enterprise v2 from v3: inspect render versus execute and widget mode. Use fresh matching session parameters; do not infer a supported native callback or target acceptance from a site key alone. Never substitute GRID automatically.
Collect fresh values from the same target/challenge. Respect product-specific hostname, action, challenge/session, IP, User-Agent and expiry requirements; these are not universally interchangeable. Apply returned cookies only to their matching domains.
Examples are placeholders, not runnable challenges. Documented result fields are not proof of target acceptance or a live availability test. Do not send unsupported fields.
SUCCEEDED means a solver result is available. Separately confirm that the target accepts the challenge and that the requested business operation completes. The solver cannot observe those two outcomes.

Input sources

Field	Input sources
`websiteURL`	Read from the actual target page, widget configuration or documented integration. Identify the precise product/version; placeholders and keys from another site cannot be substituted.
`websiteKey`	Read from the actual target page, widget configuration or documented integration. Identify the precise product/version; placeholders and keys from another site cannot be substituted.
`pageAction`	Actual v3 action from the target execute options. This legacy field remains accepted for v2 compatibility, but it does not replace data-s or enterprisePayload.s and does not select the product version.
`apiDomain`	Read from the actual target page, widget configuration or documented integration. Identify the precise product/version; placeholders and keys from another site cannot be substituted.
`isEnterprise`	For RECAPTCHA_V3_ENTERPRISE the upstream flag is always true, including legacy requests that send false. RECAPTCHA_V3 keeps its existing optional flag behavior. Select the explicit v2 Enterprise product for Enterprise widgets; this flag cannot supply missing session parameters.
`minScore`	Set according to the actual challenge and product field meaning. These are solving options, not values to invent to repair a failed request.
`userAgent`	Read the actual User-Agent used to obtain this challenge; preserve it when the product requires matching.

Request example

POST /api/validator/create.cgi · JSONC

{
"productCode": "RECAPTCHA_V3_ENTERPRISE", // Product code matching the adapter parameters.
"adapter": { // Product-specific parameter object.
"websiteURL": "https://example.com/register", // Read from the actual target page, widget configuration or documented integration. Identify the precise product/version; placeholders and keys from another site cannot be substituted.
"websiteKey": "YOUR_WEBSITEKEY", // Read from the actual target page, widget configuration or documented integration. Identify the precise product/version; placeholders and keys from another site cannot be substituted.
"pageAction": "YOUR_PAGEACTION", // Actual v3 action from the target execute options. This legacy field remains accepted for v2 compatibility, but it does not replace data-s or enterprisePayload.s and does not select the product version.
"apiDomain": "YOUR_APIDOMAIN", // Read from the actual target page, widget configuration or documented integration. Identify the precise product/version; placeholders and keys from another site cannot be substituted.
"isEnterprise": true, // For RECAPTCHA_V3_ENTERPRISE the upstream flag is always true, including legacy requests that send false. RECAPTCHA_V3 keeps its existing optional flag behavior. Select the explicit v2 Enterprise product for Enterprise widgets; this flag cannot supply missing session parameters.
"minScore": 0.3, // Set according to the actual challenge and product field meaning. These are solving options, not values to invent to repair a failed request.
"userAgent": "YOUR_BROWSER_USER_AGENT" // Read the actual User-Agent used to obtain this challenge; preserve it when the product requires matching.
}
}

Request headers: apiKey: YOUR_API_KEY

Comments explain the fields. Copy produces valid JSON without comments.

Response example

POST /api/validator/query.cgi · JSONC

{
  "code": 0, // Business result code: 0 means success; other values indicate an error.
  "msg": "Success", // Result message; may be empty on success.
  "data": { // Response data; may be null on an error.
    "taskId": "11111111-1111-4111-8111-111111111111", // Task ID returned by task creation.
    "productCode": "RECAPTCHA_V3_ENTERPRISE", // Product code matching the adapter parameters.
    "state": "SUCCEEDED", // Task state: CREATED, SUBMITTING, PROCESSING, SUCCEEDED, FAILED or EXPIRED.
    "solution": { // Product answer when SUCCEEDED; empty while processing or on failure.
      "gRecaptchaResponse": "EXAMPLE_GRECAPTCHARESPONSE", // Verification token to submit to the target website.
      "token": "EXAMPLE_TOKEN" // Verification token to submit to the target website.
    }
  }
}

Creating a task returns its ID and initial state. Query the result or use WebSocket to receive the completed answer shown below.

Request parameters

Field	Type	Required	Description
`productCode`	string	Yes	Product code matching the adapter parameters.
`adapter`	object	Yes	Product-specific parameter object.
`adapter.websiteURL`	string	Yes	Read from the actual target page, widget configuration or documented integration. Identify the precise product/version; placeholders and keys from another site cannot be substituted.
`adapter.websiteKey`	string	Yes	Read from the actual target page, widget configuration or documented integration. Identify the precise product/version; placeholders and keys from another site cannot be substituted.
`adapter.pageAction`	string	No	Actual v3 action from the target execute options. This legacy field remains accepted for v2 compatibility, but it does not replace data-s or enterprisePayload.s and does not select the product version.
`adapter.apiDomain`	string	No	Read from the actual target page, widget configuration or documented integration. Identify the precise product/version; placeholders and keys from another site cannot be substituted.
`adapter.isEnterprise`	boolean	No	For RECAPTCHA_V3_ENTERPRISE the upstream flag is always true, including legacy requests that send false. RECAPTCHA_V3 keeps its existing optional flag behavior. Select the explicit v2 Enterprise product for Enterprise widgets; this flag cannot supply missing session parameters.
`adapter.minScore`	number	Yes	Set according to the actual challenge and product field meaning. These are solving options, not values to invent to repair a failed request.
`adapter.userAgent`	string	No	Read the actual User-Agent used to obtain this challenge; preserve it when the product requires matching.

Response parameters

Field	Type	Description
`code`	integer	Business result code: 0 means success; other values indicate an error.
`msg`	string	Result message; may be empty on success.
`data`	object \| null	Response data; may be null on an error.
`data.taskId`	string	Task ID returned by task creation.
`data.productCode`	string	Product code matching the adapter parameters.
`data.state`	string	Task state: CREATED, SUBMITTING, PROCESSING, SUCCEEDED, FAILED or EXPIRED.
`data.solution`	object	Product answer when SUCCEEDED; empty while processing or on failure.
`data.failure`	object \| omitted	Public diagnosis for FAILED/EXPIRED only; no raw provider messages. Follow the failure handling guide.
`data.failure.code`	string	Failure code
`data.failure.nextAction`	string	Next action
`data.solution.gRecaptchaResponse`	string	Verification token to submit to the target website.
`data.solution.token`	string	Verification token to submit to the target website.

Responses

HTTP business responses contain code, msg and data; code 0 means success. WebSocket uses a separate message structure.

-1317: Invalid API key.
-1100 / -1101: Invalid or missing request parameters.
-1401: Insufficient balance. Add funds before creating a task.
-1400 / -1001: System or task creation error.

API documentation

reCAPTCHA v3 Enterprise

Create task

Request preview

Response example

reCAPTCHA v3 Enterprise · API

Request example

Response example

Request parameters

Response parameters

Responses