VEvelopaymentsapi
Users

Validate the proposed password

Changed on

validate the password and return a score

post/v2/users/self/password/validate

Request

  • Base URL
    https://api.sandbox.velopayments.com
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.sandbox.velopayments.com/v1/login

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]"
  ]
}

Changes

  • 05c3f09fc50aRevision changes
    • breaking

      the request property's maxLength was decreased to 64

    • breaking

      the request property's minLength was increased from 8 to 10

  • dd71433847a6Revision changes
    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/locationType deprecated

    • info

      response property errors/items/reasonCode deprecated

    • info

      response property errors/items/reasonCode deprecated

    • info

      response property errors/items/reasonCode deprecated