About this endpoint
What it does
Scores a password based on its length, complexity, and common-password checks. It takes a password query parameter and returns a JSON object with the score details.
Query Parameter(s)
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| password | String | Yes | The password to evaluate. |
Response
Returns a JSON object with four top-level fields: max as an integer, level as a string enum, score as an integer, and checks as an object whose properties are booleans. The level field can be one of very_weak, weak, fair, strong, or very_strong.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| max | Integer | No | Maximum score value returned by the service. |
| level | ENUM | No | Password strength level. Allowed values: very_weak, weak, fair, strong, very_strong. |
| score | Integer | No | Score assigned to the password. |
| checks | Object | No | Object containing boolean check results. Each property name maps to a boolean value. |