CaptchaVerificationPublicService

Overview

The CaptchaVerificationPublicService provides functionality to verify whether a CAPTCHA challenge has been successfully completed. This service is intended for use in authentication workflows where CAPTCHA verification is required.

Available Functions

verifyCaptcha(String userResponseToken, String source, String username, String idHubSessionId): int

Verifies if the provided CAPTCHA response token is valid.

• Parameters:

  • userResponseToken (String): The response token provided by the user (g-recaptcha-response parameter in the HTTP request).

  • source (String, optional): The source IP address for event logging.

  • username (String, optional): The username associated with the CAPTCHA request, used for event tracking.

  • idHubSessionId (String, optional): The session ID from the IDHub system for event tracking.

• Returns:

  • int: The HTTP status code indicating the result of the verification.

    • A successful verification will return a 200 status code.

    • A failed verification will return an appropriate error code.

Summary

The CaptchaVerificationPublicService allows applications to validate CAPTCHA responses and log associated metadata, such as IP addresses, usernames, and session IDs, for security purposes. It is a crucial component for preventing automated bot interactions and ensuring secure authentication workflows.