Set up a reCAPTCHA site profile

By solvethree3 min read

Set up the site in Site profiles and wait for its profile to show active before requesting a token. Sending a hostname and action to the task API doesn't create a profile.

On this page

Add the site in the console

  1. 1.

    Check the workspace

    Set up the profile for the workspace whose API key you'll use to create tasks. A profile in another workspace isn't enough. If the console shows Add credit to continue, use that prompt before continuing setup.

  2. 2.

    Open Add a site

    In Site profiles, select Add a site. Enter the target HTTPS page in Page URL. Under reCAPTCHA type, choose Enterprise v3 or Regular v3 to match the page.

  3. 3.

    Set the capture inputs

    Capture action is required. Use the action you intend to solve for; if you're unsure, find the reCAPTCHA action first. The form also has optional Navigation URL, Site key and Referer value fields. The Site key can be auto-discovered.

  4. 4.

    Submit the form

    Select Add site. Reviewed system profiles can fill the known page contract and capture action without a live pull; the form explains the chosen action. Other submissions can enter queued, capturing, validating or review states.

Check the resulting profile's status. ACTIVE is displayed as active, and that is the state required for solving. If capture fails, the console shows a reason and lets you retry.

Request a token using the active profile

This task body uses the hostname and action from the profile:

reCAPTCHA Enterprise · request shape
{
  "site": "accounts.example.com",
  "action": "login",
  "proxy": "http://user:[email protected]:8080",
  "requestId": "example_login_001"
}
  • site is the hostname from Page URL, without its scheme or path.
  • action is the action for the protected request. Match the profile you intend to use.
  • The default recaptchaType is enterprise-v3. For a Regular v3 profile, explicitly set it to v3.
  • Replace the proxy placeholder with the HTTP(S) proxy you will also use for the target request.

The Python quickstart and Node.js quickstart show how to send the request and use the result.

Fix a missing or inactive profile

No profile is available for the task.

Compare the workspace associated with your API key and the task's hostname with the profile you configured.

Try this: Add the intended site profile in the workspace that will create the task. Repeating task creation won't create the missing profile.

The profile is queued, capturing, validating or in review.

Read its current state in Site profiles.

Try this: Wait for the profile to become active before requesting a solve. These states aren't substitutes for an active profile.

Capture failed.

Read the failure reason shown in the console.

Try this: Correct the issue identified by that reason, then retry the capture.

A profile is active, but the intended action still doesn't resolve.

Compare the hostname, capture action and reCAPTCHA type. If the execution action differs, check whether there is one unambiguous capture target.

Try this: Set up a profile matching the intended hostname, action and type rather than changing the task to an unrelated action just to select an existing profile.

Sources and API reference

Run your first task.

Start with $5 in workspace credit.

Create a workspace