ping-identity
    Preparing search index...

    Type Alias RecaptchaVerifyOptions

    Options for executing an active Journey ReCaptchaEnterpriseCallback.

    The reCAPTCHA site key is NOT caller-supplied — the native callback reads it from the server payload (Android reCaptchaSiteKey, iOS recaptchaSiteKey), mirroring native verify() semantics.

    type RecaptchaVerifyOptions = {
        action?: string;
        index?: number;
        payload?: RecaptchaJsonValue;
        timeoutMs?: number;
    }
    Index

    Properties

    action? index? payload? timeoutMs?

    Properties

    action?: string

    reCAPTCHA action name associated with this verification.

    Defaults to 'login' on both platforms. Android maps 'login' to RecaptchaAction.LOGIN, 'signup' to RecaptchaAction.SIGNUP, and any other value to RecaptchaAction.custom(value). iOS passes the string to RecaptchaAction(customAction:) directly.

    index?: number

    Optional callback index when multiple ReCaptchaEnterpriseCallbacks are present.

    payload?: RecaptchaJsonValue

    Optional custom risk-assessment metadata submitted with the verification.

    timeoutMs?: number

    Verification timeout in milliseconds.

    Defaults to 15000 and is always passed explicitly to both platforms so behavior is identical despite the native defaults differing (Android 10000ms, iOS 15000ms).

    Settings

    Member Visibility

    On This Page

    Properties