ROrossum
User

Retrieve password score

Score to allow users to see how strong their password is from 0 (risky password) to 4 (strong password).

post/api/v1/auth/password/score

Request

Request body

passwordstring required

Password to be scored

emailstring email

Email of the user

first_namestring

First name of the user

last_namestring

Last name of the user

Example request

{
  "password": "MySecureP@ssw0rd",
  "email": "joe.doe@example.com",
  "first_name": "Joe",
  "last_name": "Doe"
}

Response

OK

scoreinteger

Password strength score from 0 (risky password) to 4 (strong password)

messagesstring[]

Suggestions from the validators

Example response

{
  "score": 2,
  "messages": [
    "Add another word or two. Uncommon words are better."
  ]
}

Changes

No recorded changes to this operation across all 14 revisions of this API.