Page Comparison

...

Parameter

Type

Required

Value

type

String

yes

GeeTestTaskProxyless

websiteURL

String

yes

Address of the page on which the captcha is recognized

gt

String

yes

The GeeTest identifier key for the domain. Static value, rarely updated.

challenge

String

yes

A dynamic key.
Each time our API is called, we need to get a new key value. If the captcha is loaded on the page, then the challenge value is no longer valid and you will get ERROR_TOKEN_EXPIRED error.

Warning
You will be charged for tasks with `ERROR_TOKEN_EXPIRED` error!

It is necessary to examine the requests and find the one in which this value is returned and, before each creation of the recognition task, execute this request and parse the challenge from it.

geetestApiServerSubdomain

String

no

Optional parameter. May be required for some sites.

geetestGetLib

String

no

Optional parameter. May be required for some sites.
Send JSON as a string.

version

Integer

no

Version number (default is 3). Possible values: 3, 4.

initParameters

Object

no

Additional parameters for version 4.

userAgent

String

no

Browser User-Agent used to recognize captcha.

GeeTest V3

Request example

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

Code Block

{
    "clientKey":"YOUR_CAPMONSTER_CLOUD_API_KEY",
    "task":
    {
        "type":"GeeTestTaskProxyless",
        "websiteURL":"https://example.com/geetest.php",
        "gt":"81dc9bdb52d04dc20036dbd8313ed055",
        "challenge":"d93591bdf7860e1e4ee2fca799911215"
    }
}

Response example

Code Block
{ "errorId":0, "taskId":407533072 }

Getting the result

Use the getTaskResult method to get the result of GeeTest recognition. Depending on the system load, you will receive a response after a time in the range from 10 s to 30 s.

Property	Type	Description
challenge	String	All three parameters are required when submitting the form on the target site.
validate	String
seccode	String

Example:

Code Block

{
    "type":"GeeTestTaskProxyless"errorId":0,
    "status":"ready",
    "solution":
    {
        "challenge":"0f759dd1ea6c4wc76cedc2991039ca4f23",
        "validate":"6275e26419211d1f526e674d97110e15",
        "seccode":"510cd9735583edcb158601067195a5eb|jordan"
    }
}

GeeTest V4

Request example

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

Code Block

{
    "clientKey":"YOUR_CAPMONSTER_CLOUD_API_KEY",
    "task":
    {
        "type":"GeeTestTaskProxyless",
        "websiteURL":"https://example.com/geetest.php",
        "gt":"81dc9bdb52d04dc20036dbd8313ed055",
        "gtversion":"81dc9bdb52d04dc20036dbd8313ed055",
  4,
        "initParameters": {
          "challengeriskType": "d93591bdf7860e1e4ee2fca799911215slide"
        }
    }
}

Response example

Code Block
{ "errorId":0, "taskId":407533072 }

Getting the result

Use the getTaskResult method to get the result of GeeTest recognition. Depending on the system load, you will receive a response after a time in the range from 10 s to 30 s.

Property

Type

Description

challenge

captcha_id

String

All

three

five parameters are required when submitting the form on the target site.

validate

lot_number	String
pass_token	String
gen_time	String

seccode

captcha_output

String

Example:

Code Block

{
    "errorId":0,
    "status":"ready",
    "solution":
    {
        "challenge"captcha_id":"f5c2ad5a8a3cf37192d8b9c039950f79",
        "lot_number":"bcb2c6ce2f8e4e9da74f2c1fa63bd713",
        "pass_token":"0f759dd1ea6c4wc76cedc2991039ca4f23edc7a17716535a5ae624ef4707cb6e7e478dc557608b068d202682c8297695cf",
        "validategen_time":"6275e26419211d1f526e674d97110e151683794919",
        "seccodecaptcha_output":"510cd9735583edcb158601067195a5eb|jordanXwmTZEJCJEnRIJBlvtEAZ662T...[cut]...SQ3fX-MyoYOVDMDXWSRQig56"
    }
}

Versions Compared

Old Version 5

New Version Current

Key

GeeTest V3

GeeTest V4