When the Identity Platform integration with the reCAPTCHA Enterprise API is enabled, Identity Platform provisions
reCAPTCHA keys on your behalf by default. However, you can
choose to bring your own reCAPTCHA key to use with
reCAPTCHA. Uploading your own reCAPTCHA key
disables the provisioning by
Identity Platform.
Enable the ability to bring your own key
To enable this capability and upload your reCAPTCHA key, call the
endpoint with the following curl command:
OAUTH_TOKEN: the credential used for administrator
requests
PROJECT_NUMBER: the project number
KEY_VALUE: the string that represents the reCAPTCHA
key you want to upload
PLATFORM_TYPE: the platform of the application using
the reCAPTCHA key. Valid values are WEB, ANDROID, and IOS.
Disable the ability to bring your own key
To continue provisioning reCAPTCHA keys through
Identity Platform, call the
endpoint with curl and pass an empty list for recaptchaConfig.recaptchaKeys. For example:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-29 UTC."],[[["\u003cp\u003eYou have the option to use your own reCAPTCHA key with Identity Platform's integration with the reCAPTCHA Enterprise API, instead of using the default provisioned keys.\u003c/p\u003e\n"],["\u003cp\u003eUploading your own reCAPTCHA key to Identity Platform will disable the automatic provisioning of keys by Identity Platform.\u003c/p\u003e\n"],["\u003cp\u003eTo enable the use of your own reCAPTCHA key, you must make a \u003ccode\u003ePATCH\u003c/code\u003e request to the specified endpoint using a \u003ccode\u003ecurl\u003c/code\u003e command, providing the key and platform type.\u003c/p\u003e\n"],["\u003cp\u003eYou can revert to Identity Platform's default reCAPTCHA key provisioning by sending a \u003ccode\u003ePATCH\u003c/code\u003e request with an empty list for \u003ccode\u003erecaptchaConfig.recaptchaKeys\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThis feature is currently subject to "Pre-GA Offerings Terms" and is provided "as is" with potentially limited support.\u003c/p\u003e\n"]]],[],null,["# Bring your own reCAPTCHA keys\n=============================\n\n|\n| **Preview**\n|\n|\n| This feature is subject to the \"Pre-GA Offerings Terms\" in the General Service Terms section\n| of the [Service Specific Terms](/terms/service-terms#1).\n|\n| Pre-GA features are available \"as is\" and might have limited support.\n|\n| For more information, see the\n| [launch stage descriptions](/products#product-launch-stages).\n\nYou can use your own reCAPTCHA key with\n[Identity Platform integration with the reCAPTCHA Enterprise API](/identity-platform/docs/recaptcha-enterprise).\n\nWhen the Identity Platform integration with the reCAPTCHA Enterprise API is enabled, Identity Platform provisions\nreCAPTCHA keys on your behalf by default. However, you can\nchoose to bring your own reCAPTCHA key to use with\nreCAPTCHA. Uploading your own reCAPTCHA key\ndisables the provisioning by\nIdentity Platform.\n\nEnable the ability to bring your own key\n----------------------------------------\n\nTo enable this capability and upload your reCAPTCHA key, call the\nendpoint with the following `curl` command: \n\n curl -i -X PATCH -H 'Content-Type: application/json' -H\n \"x-goog-user-project: \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e\" -H 'Authorization: Bearer \u003cvar translate=\"no\"\u003eOAUTH_TOKEN\u003c/var\u003e' -d\n '\n {\n \"recaptchaConfig\": {\n \"recaptchaKeys\": [{\"key\": \"projects/\u003cvar translate=\"no\"\u003ePROJECT_NUMBER\u003c/var\u003e/keys/\u003cvar translate=\"no\"\u003eKEY_VALUE\u003c/var\u003e\",\n \"type\": \"\u003cvar translate=\"no\"\u003ePLATFORM_TYPE\u003c/var\u003e\"}],\n },\n }'\n https://identitytoolkit.googleapis.com/v2/projects/\u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e/config?updateMask=recaptchaConfig.recaptchaKeys\n\nReplace the following:\n\n- \u003cvar translate=\"no\"\u003e\u003ccode translate=\"no\" dir=\"ltr\"\u003ePROJECT_ID\u003c/code\u003e\u003c/var\u003e: the project ID\n- \u003cvar translate=\"no\"\u003e\u003ccode translate=\"no\" dir=\"ltr\"\u003eOAUTH_TOKEN\u003c/code\u003e\u003c/var\u003e: the credential used for administrator requests\n- \u003cvar translate=\"no\"\u003e\u003ccode translate=\"no\" dir=\"ltr\"\u003ePROJECT_NUMBER\u003c/code\u003e\u003c/var\u003e: the project number\n- \u003cvar translate=\"no\"\u003e\u003ccode translate=\"no\" dir=\"ltr\"\u003eKEY_VALUE\u003c/code\u003e\u003c/var\u003e: the string that represents the reCAPTCHA key you want to upload\n- \u003cvar translate=\"no\"\u003e\u003ccode translate=\"no\" dir=\"ltr\"\u003ePLATFORM_TYPE\u003c/code\u003e\u003c/var\u003e: the platform of the application using the reCAPTCHA key. Valid values are `WEB`, `ANDROID`, and `IOS`.\n\nDisable the ability to bring your own key\n-----------------------------------------\n\nTo continue provisioning reCAPTCHA keys through\nIdentity Platform, call the\nendpoint with `curl` and pass an empty list for `recaptchaConfig.recaptchaKeys`. For example: \n\n curl -i -X PATCH -H 'Content-Type: application/json' -H \"x-goog-user-project:\n \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e\" -H 'Authorization: Bearer \u003cvar translate=\"no\"\u003eOAUTH_TOKEN\u003c/var\u003e' -d '\n {\n \"recaptchaConfig\": {\n \"recaptchaKeys\": [],\n },\n }'\n https://identitytoolkit.googleapis.com/v2/projects/\u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e/config?updateMask=recaptchaConfig.recaptchaKeys\n\nReplace the following:\n\n- \u003cvar translate=\"no\"\u003e\u003ccode translate=\"no\" dir=\"ltr\"\u003ePROJECT_ID\u003c/code\u003e\u003c/var\u003e: the project ID\n- \u003cvar translate=\"no\"\u003e\u003ccode translate=\"no\" dir=\"ltr\"\u003eOAUTH_TOKEN\u003c/code\u003e\u003c/var\u003e: the credential used for administrator requests"]]
