Google

reCAPTCHA Enterprise API

Help protect your website from fraudulent activity, spam, and abuse without creating friction.

Identity & security#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Help protect your website from fraudulent activity, spam, and abuse without creating friction.

Endpoints 18

projects.assessments

  • POSTAnnotates a previously created Assessment to provide additional information on whether the event turned out to be…/v1/:name:annotateAnnotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fraudulent.
  • POSTCreates an Assessment of the likelihood an event is legitimate./v1/:parent/assessmentsCreates an Assessment of the likelihood an event is legitimate.

projects.firewallpolicies

  • GETReturns the list of all firewall policies that belong to a project./v1/:parent/firewallpolicies?pageSize=0&pageToken=stringReturns the list of all firewall policies that belong to a project.
  • POSTCreates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed/v1/:parent/firewallpoliciesCreates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed. A project may have a maximum of 1000 policies.
  • POSTReorders all firewall policies./v1/:parent/firewallpolicies:reorderReorders all firewall policies.

projects.keys

  • GETGet the policy for a key./v1/:nameGet the policy for a key.
  • DELETEDeletes the specified key./v1/:nameDeletes the specified key.
  • PATCHUpdates the policy for a key./v1/:name?updateMask=stringUpdates the policy for a key.
  • POSTAdds an IP override to a key/v1/:name:addIpOverrideAdds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 1000. * For any conflict (such as IP already…
  • GETReturns the list of all keys that belong to a project./v1/:parent/keys?pageSize=0&pageToken=stringReturns the list of all keys that belong to a project.
  • POSTCreates a new reCAPTCHA Enterprise key./v1/:parent/keysCreates a new reCAPTCHA Enterprise key.
  • GETLists all IP overrides for a key./v1/:parent:listIpOverrides?pageSize=0&pageToken=stringLists all IP overrides for a key.
  • POSTMigrates an existing key from reCAPTCHA to reCAPTCHA Enterprise/v1/:name:migrateMigrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. Once a key is migrated, it can be used from either product. SiteVerify requests are billed as…
  • POSTRemoves an IP override from a key/v1/:name:removeIpOverrideRemoves an IP override from a key. The following restrictions hold: * If the IP isn't found in an existing IP override, a NOT_FOUND error is returned. * If…
  • GETReturns the secret key related to the specified public key/v1/:key:retrieveLegacySecretKeyReturns the secret key related to the specified public key. You must use the legacy secret key only in a 3rd party integration with legacy reCAPTCHA.

projects.relatedaccountgroupmemberships

  • POSTSearch group memberships related to a given account./v1/:project/relatedaccountgroupmemberships:searchSearch group memberships related to a given account.

projects.relatedaccountgroups

  • GETList groups of related accounts./v1/:parent/relatedaccountgroups?pageSize=0&pageToken=stringList groups of related accounts.

projects.relatedaccountgroups.memberships

  • GETGet memberships in a group of related accounts./v1/:parent/memberships?pageSize=0&pageToken=stringGet memberships in a group of related accounts.

API details

Base URL
https://recaptchaenterprise.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter
Operations
18 operations on 14 pathsPOST 9GET 7PATCH 1DELETE 1
Main resources
projects.keys 10projects.firewallpolicies 3projects.assessments 2projects.relatedaccountgroupmemberships 1projects.relatedaccountgroups 1projects.relatedaccountgroups.memberships 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the reCAPTCHA Enterprise API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the reCAPTCHA Enterprise API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Annotates a previously created Assessment to provide additional information on whether the event turned out to be…” (POST /v1/:name:annotate), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the reCAPTCHA Enterprise API?

Help protect your website from fraudulent activity, spam, and abuse without creating friction. It is listed under Identity & security and has 18 endpoints.

Who publishes the reCAPTCHA Enterprise API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the reCAPTCHA Enterprise API?

Requests go to https://recaptchaenterprise.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the reCAPTCHA Enterprise API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.

How many endpoints does the reCAPTCHA Enterprise API have?

18 operations on 14 paths (9 POST, 7 GET, 1 PATCH, 1 DELETE). The largest groups are projects.keys, projects.firewallpolicies, projects.assessments, projects.relatedaccountgroupmemberships.

Is forking the reCAPTCHA Enterprise API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.