Skip to content

Validate password

Request

Validates a new password according to the requesting application's password policy. The validation includes checking the password complexity (such as minimum length and character requirements) and password history (i.e., that the same password wasn't used too recently). This can be used before updating a user's password to first check that the password they chose is valid and if not, provide feedback to the user.

Required permissions: apps:execute, [appId]:execute, auth:execute.

Security
ClientAccessToken
Bodyapplication/jsonrequired
emailstring

Email of the user who provided the password. Used to identify the user to check password history.

phone_numberstring

Phone number of the user who provided the password. Used to identify the user to check password history.

usernamestring

Username of the user who provided the password. Used to identify the user to check password history.

passwordstringrequired

Password to validate

curl -i -X POST \
  https://api.sbx.transmitsecurity.io/cis/v1/auth/password/validate \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "string",
    "phone_number": "string",
    "username": "string",
    "password": "string"
  }'

Responses

Bodyapplication/json
resultobjectrequired

Result of password validation

Response
{
  "result": {
    "valid_password": true,
    "errors": [ … ]
  }
}