Strength check

The strengthCheck method wraps the Strength Check Password API endpoint.

This method allows you to check whether or not the user’s provided password is valid, and to provide feedback to the user on how to increase the strength of their password. All passwords must pass the strength requirements to be accepted as valid.

Method parameters

password* string

email string

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

export const Login = () => {
  const stytch = useStytch();

  const strengthCheck = useCallback(() => {
    stytch.passwords.strengthCheck({
      email: '${exampleEmail}',
      password: 'xS)ISUi)PNKFx#pJ',
    });
  }, [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
  }