v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB

Users

Validate the proposed password

validate the password and return a score

post/v2/users/self/password/validate

Request body

passwordstring required

a password that passes validation

Example request

{
  "password": "My_strong_password"
}

Response

the password was checked and a score returned

scoreinteger

More secure passwords are given a higher score. <P> For a password to be acceptable for use in Velo, it must score at least 3

validboolean

if true then the password can be accepted

warningstring

Any warning message as a reason for the given score.

suggestionsstring[]

Example response

{
  "valid": true,
  "score": 2,
  "warning": "Historic Password",
  "suggestions": [
    "[password has been used before]",
    "[password has been used before]"
  ]
}