Method: projects.apps.exchangeRecaptchaToken

Validates a reCAPTCHA v3 response token . If valid, returns an AppCheckToken .

HTTP request

POST https://firebaseappcheck.googleapis.com/v1beta/{app=projects/*/apps/*}:exchangeRecaptchaToken

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
app

string

Required. The relative resource name of the web app, in the format:

projects/{project_number}/apps/{app_id}

If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.

Request body

The request body contains data with the following structure:

JSON representation
{
  "recaptchaToken": string
}
Fields
recaptchaToken

string

Required. The reCAPTCHA token as returned by the reCAPTCHA v3 JavaScript API .

Response body

If successful, the response body contains an instance of AppCheckToken .