Quickstart

This page shows you how to get setup to use reCAPTCHA Enterprise.

Before you begin

  1. Get allowlisted for the reCAPTCHA Enterprise API.

    reCAPTCHA Enterprise is not available for everyone at this time, so you must go through a process to gain access.

    Complete the reCAPTCHA Enterprise Program form. You will need to include the following information:

    • Email address for someone who is an owner of the Google Cloud project. This person will be able to enable the reCAPTCHA Enterprise API once we have allowed their account. This should be the email address they use to login to the Google Cloud Console. All members of your team that will be enabling the reCAPTCHA Enterprise API on projects must fill out the form.

    Wait for a reply confirming that enabling the account is completed.

  1. Sign in to your Google Account.

    If you don't already have one, sign up for a new account.

  2. In the Cloud Console, on the project selector page, select or create a Cloud project.

    Go to the project selector page

  3. Learn more about creating and managing projects.

  4. Make sure that billing is enabled for your Google Cloud project. Learn how to confirm billing is enabled for your project.

  5. Enable the reCAPTCHA Enterprise API.

    Enable the API

  6. 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.
  7. Set the environment variable GOOGLE_APPLICATION_CREDENTIALS to the 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.

  8. Install and initialize the Cloud SDK.

Clean up

There are no clean up steps required.

What's next