Skip to main content

reCAPTCHA

The reCAPTCHA provider verifies tokens using Google’s siteverify endpoint.

reCAPTCHA provider configuration

FieldTypeRequiredDefaultNotes
secretKeystring✅ YesreCAPTCHA secret key from Google.
endpointstring❌ Nohttps://www.google.com/recaptcha/api/siteverifyCustom endpoint override (rarely needed).

Request requirements

The module expects a captcha token to be sent with each protected request. By default:

  • Location: headers
  • Field name: x-captcha-token

These are configurable via guardOptions.