Skip to main content
POST
Check a password

Authorizations

Authorization
string
header
required

Your Finowl API key, for example finowl_3f9a.... Create keys in the dashboard under API Keys.

Body

application/json
password
string
required

The password to check, exactly as the user typed it. Whitespace and case are preserved.

Required string length: 1 - 4096
Example:

"P@ssw0rd"

Response

The check completed.

breached
boolean
required

true when the password appears at least once.

count
integer
required

How many times the password appears across known breaches.

Required range: x >= 0