Strength check

The strengthCheck method wraps the Strength Check Password API endpoint.

This endpoint allows you to check whether or not the Member’s provided password is valid, and to provide feedback to the Member on how to increase the strength of their password.

Method parameters

password* string

email_address string

Response fields

request_id string

status_code int

breach_detection_on_create boolean

breached_password boolean

score int

strength_policy int

valid_password boolean

import React, { useCallback } from 'react';
import { useStytchB2BClient } from '@stytch/react/b2b';

export const StrengthCheck = () => {
  const stytch = useStytchB2BClient();

  const strengthCheck = useCallback(() => {
    stytch.passwords.strengthCheck({
      password: '$B&M)3$B$eCk_2@c',
    });
  }, [stytch]);

  return <button onClick={strengthCheck}>Strength Check</button>;
};

RESPONSE

{
    "breach_detection_on_create": true,
    "breached_password": false,
    "feedback": {
      "suggestions": null,
      "warning": null,
      "luds_requirements": {
        "has_digit": true,
        "has_lower_case": false,
        "has_symbol": false,
        "has_upper_case": false,
        "missing_characters": 6,
        "missing_complexity": 1
      }
    },
    "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
    "score": 0,
    "status_code": 200,
    "strength_policy": "luds",
    "valid_password": false
}