PRODUCT TEST WORKSPACE

GeeTest

Captcha verification product

GEETEST

02 / REQUEST

Request preview

POST /api/validator/create.cgi

{
  "productCode" : "GEETEST",
  "adapter" : {
    "websiteURL" : "https://example.com/register",
    "gt" : "YOUR_GT",
    "challenge" : "YOUR_CHALLENGE"
  }
}

03 / RESULT

Response example

EXAMPLE

Task ID —

{
  "code" : 0,
  "msg" : "Success",
  "data" : {
    "taskId" : "11111111-1111-4111-8111-111111111111",
    "productCode" : "GEETEST",
    "state" : "SUCCEEDED",
    "solution" : {
      "challenge" : "EXAMPLE_CHALLENGE",
      "validate" : "EXAMPLE_VALIDATE",
      "seccode" : "EXAMPLE_SECCODE"
    }
  }
}

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

GeeTest · 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

STRUCTURED_PROOF

GeeTest v3 (initGeetest): obtain a new, unused challenge for every new solver task. A challenge already loaded by the page is no longer valid for the solver; copying the current widget value is not sufficient. Submit solution.challenge, validate and seccode together through the matching target session. Do not treat this as v4.

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.
GeeTest v3 (initGeetest): obtain a new, unused challenge for every new solver task. A challenge already loaded by the page is no longer valid for the solver; copying the current widget value is not sufficient. Submit solution.challenge, validate and seccode together through the matching target session. Do not treat this as v4.
For PROVIDER_UNSOLVABLE, inspect the precise version, initialization source, challenge consumption/expiry, API hostname, actual User-Agent and target session. Different challenge values do not prove freshness. Solver failure occurs before any successful proof can be applied. A changed challenge is a new paid task, not a transport retry.
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.
`gt`	The gt issued by the target initGeetest v3 integration; not a v4 captcha_id. Do not substitute a demo or another integration identifier.
`challenge`	Obtain a new, unused v3 challenge from the target initialization endpoint for every new task. Once loaded by the page it is no longer valid for the solver. Keep its target session; do not reuse it or infer freshness from length.
`apiServerSubdomain`	Optional v3 GeeTest API hostname from the target configuration, for example api-na.geetest.com. Omit if not configured or unknown; never submit YOUR_* placeholders. The existing public field name remains unchanged.
`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": "GEETEST", // Product code matching the adapter parameters.
  "adapter": { // Product-specific parameter object.
    "websiteURL": "https://example.com/register", // Full URL of the page containing the challenge.
    "gt": "YOUR_GT", // The gt issued by the target initGeetest v3 integration; not a v4 captcha_id. Do not substitute a demo or another integration identifier.
    "challenge": "YOUR_CHALLENGE" // Obtain a new, unused v3 challenge from the target initialization endpoint for every new task. Once loaded by the page it is no longer valid for the solver. Keep its target session; do not reuse it or infer freshness from length.
  }
}

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": "GEETEST", // 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.
      "challenge": "EXAMPLE_CHALLENGE", // Product-specific answer field; use it according to the target website verification protocol.
      "validate": "EXAMPLE_VALIDATE", // Product-specific answer field; use it according to the target website verification protocol.
      "seccode": "EXAMPLE_SECCODE" // Product-specific answer field; use it according to the target website verification protocol.
    }
  }
}

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	Full URL of the page containing the challenge.
`adapter.gt`	string	Yes	The gt issued by the target initGeetest v3 integration; not a v4 captcha_id. Do not substitute a demo or another integration identifier.
`adapter.challenge`	string	Yes	Obtain a new, unused v3 challenge from the target initialization endpoint for every new task. Once loaded by the page it is no longer valid for the solver. Keep its target session; do not reuse it or infer freshness from length.
`adapter.apiServerSubdomain`	string	No	Optional v3 GeeTest API hostname from the target configuration, for example api-na.geetest.com. Omit if not configured or unknown; never submit YOUR_* placeholders. The existing public field name remains unchanged.
`adapter.userAgent`	string	No	User-Agent of the browser that obtained the challenge.

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.challenge`	string	Product-specific answer field; use it according to the target website verification protocol.
`data.solution.validate`	string	Product-specific answer field; use it according to the target website verification protocol.
`data.solution.seccode`	string	Product-specific answer field; use it according to the target website verification protocol.

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

GeeTest

Create task

Request preview

Response example

GeeTest · API

Request example

Response example

Request parameters

Response parameters

Responses