Skip to main content
Have I Been Pwned
Previewv0.1.0
18 actions · 1 auth method
Security

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.
3

Link an Account

Link an account from the dashboard (or via StackOne Hub).
4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

​
Actions

18 actions
Action
Description
List Account Breaches
Returns the breaches an email address, username, or phone number appears in.
Search Account Breach Range
Returns breached email hash suffixes and their breach names for a 6-character SHA-1 prefix (k-anonymity).
List Breaches
Returns the full catalogue of breaches loaded into Have I Been Pwned.
Get Breach
Returns the full breach model for a single breach by its Name.
Get Latest Breach
Returns the breach most recently added to Have I Been Pwned.
List Data Classes
Returns the alphabetical list of data class names seen across breaches.
List Data Class Descriptions
Returns the alphabetical list of data classes seen across breaches, with a description of each.
List Domain Breached Emails
Returns every breached email alias on a verified domain and the breaches each alias appears in.
List Subscribed Domains
Returns the verified domains linked to the API key, with breach counts.
Generate Domain DNS Token
Generates the TXT record value used to verify control of a domain via DNS.
Verify Domain DNS Token
Checks the domain’s hibp-verify TXT record and marks the domain verified when it matches.
Send Domain Verification Email
Sends a verification email to an alias on the domain so domain control can be approved by link.
Search Pwned Password Range
Returns pwned password hash suffixes and their breach counts for a 5-character hash prefix (k-anonymity).
List Account Pastes
Returns the pastes an email address has appeared in.
List Stealer Logs By Email
Returns the website domains an email address’s credentials were captured on by info-stealer malware.
List Stealer Logs By Website Domain
Returns the email addresses whose credentials were captured on a website domain by info-stealer malware.
List Stealer Logs By Email Domain
Returns the email aliases on a domain that appear in stealer logs, mapped to the website domains they were captured on.
Get Subscription Status
Returns the plan, rate limit, expiry, and capabilities of the subscription behind the API key.