Documentation

Data attributes

Reference all supported widget attributes for endpoints, variants, triggers, labels, branding, and expiration.

Core attributes

AttributeDefaultPurpose
data-api-endpoint-Required public challenge endpoint from the project snippet.
data-variantdefaultUse default, compact, or invisible.
data-triggerclickUse click, interaction, or load.
data-hidden-field-namehumanproof-tokenChanges the hidden input name submitted with your form.
data-brandingvisibleUse none to hide HumanProof branding on plans that allow unbranded widgets.
data-expire-after600000Token lifetime in milliseconds. The default is 10 minutes.
data-worker-countautoOptional worker count override for challenge solving.
data-load-error-labelHumanProof could not load...Fallback text shown by the watchdog when the script cannot initialize the widget.

Label attributes

<human-proof
  data-i18n-initial-state="Verify you are human"
  data-i18n-verifying-label="Verifying..."
  data-i18n-solved-label="Verified"
  data-i18n-error-label="Verification failed"
  data-i18n-compact-initial-label="Protected"
  data-i18n-compact-verifying-label="Verifying"
  data-i18n-compact-verified-label="Verified"
  data-i18n-compact-error-label="Blocked"
  data-i18n-limit-label="Monthly protected attempt limit reached"
  data-i18n-billing-error-label="Billing action required"
  data-i18n-unavailable-label="Verification unavailable"
></human-proof>

ARIA attributes

<human-proof
  data-i18n-verify-aria-label="Click to verify"
  data-i18n-verifying-aria-label="Verification in progress"
  data-i18n-verified-aria-label="Verified"
  data-i18n-error-aria-label="Verification failed"
></human-proof>