recaptchaFormConfig query

The recaptchaFormConfig query returns information about the reCaptcha configuration for the specified form type. To query multiple form types, use the recaptchaFormConfigs query.

You can use the recaptchaV3Config query to return a list of form types.

Syntax

recaptchaFormConfig(formType: ReCaptchaFormEnum!): ReCaptchaConfigOutput

Reference

The recaptchaFormConfig reference provides detailed information about the types and fields defined in this query.

• Adobe Commerce as a Cloud Service

• On-Premises/Cloud

Example usage

The following query returns information about the reCaptcha configuration for the CONTACT form:

Request:

query {
    recaptchaFormConfig(formType:CONTACT) {
        is_enabled
        configurations {
            re_captcha_type
            badge_position
            website_key
            theme
            language_code
            minimum_score
            validation_failure_message
            technical_failure_message
        }
    }
}

Response:

If reCaptcha is enabled for the specified form type, the response contains full configuration details.

{
  "data": {
    "recaptchaFormConfig": {
      "is_enabled": true,
      "configurations": {
        "re_captcha_type": "RECAPTCHA_V3",
        "badge_position": "inline",
        "website_key": "testtest",
        "theme": "light",
        "language_code": "en",
        "minimum_score": 0.5,
        "validation_failure_message": "Validation Failure Message",
        "technical_failure_message": "Technical Failure Message"
      }
    }
  }
}

Otherwise, the configurations object contains a null response:

{
  "data": {
    "recaptchaFormConfig": {
      "is_enabled": false,
      "configurations": null
    }
  }
}