Setting up reCAPTCHA Enterprise

This quickstart guides you through enabling the reCAPTCHA Enterprise API, setting up the required authentication, setting the environment variables, and installing and initializing Cloud SDK.

Before you begin

  1. Create a Google Cloud project. Learn how to create a Google Cloud project.
  2. Make sure that billing is enabled for your Cloud project. Learn how to confirm that billing is enabled for your project.

Enabling the API

  1. Enable the reCAPTCHA Enterprise API.

    Enable the API

  2. Set up authentication:
    1. In the Cloud Console, go to the Create service account key page.

      Go to the Create Service Account Key page
    2. From the Service account list, select New service account.
    3. In the Service account name field, enter a name.
    4. From the Role list, select reCAPTCHA Enterprise > reCAPTCHA Enterprise Agent.

      Note: The Role field authorizes your service account to access resources. You can view and change this field later by using the Cloud Console. The suggested role, reCAPTCHA Enterprise Agent, will allow the service account to create and edit assessments.

      Learn more about Access Control with reCAPTCHA Enterprise
    5. Click Create. A JSON file that contains your key downloads to your computer.
    6. Modify IAM permissions for anyone on your team who will need access to reCAPTCHA Enterprise. Team members viewing keys need to have reCAPTCHA Enterprise Viewer. Team members creating keys need to have reCAPTCHA Enterprise Admin.
  3. Provide authentication credentials to your application code by setting the environment variable GOOGLE_APPLICATION_CREDENTIALS. Replace [PATH] with the file path of the JSON file that contains your service account key. This variable only applies to your current shell session, so if you open a new session, set the variable again.

    Linux or macOS


    For example:

    export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/my-key.json"


    With PowerShell:


    For example:


    With command prompt:

  4. Install and initialize the Cloud SDK.

What's next