Skip to main content
POST
Check password against breach database

Authorizations

Authorization
string
header
required

All API requests must include a valid Bearer token in the Authorization header. Tokens are 64-character SHA-256 session hashes issued by the PropOps authentication system.

Example:

Body

application/json
password
string<password>
required
Minimum string length: 4
Example:

"P@ssw0rd123"

csrf_token
string
required
Example:

"abc123def456"

return_count
boolean
default:false

Response

Breach check result

success
boolean
Example:

true

message
string
Example:

"This password has appeared in 3,200 data breaches."

breached
boolean
Example:

true

count
integer
Example:

3200