Identity exposure

Check an email address against known data breaches

Looks the address up across 13B+ compromised accounts and returns every breach it appears in, with the date and the classes of data exposed. Call it before trusting a new user identity or granting elevated access.

Billing. $0.10 per successful call. Failed calls are never billed. Charged against prepaid credits when the balance covers it, otherwise metered to your card. Threat Intelligence subscribers and AWS Marketplace bundle customers call this at no extra charge.

post/v1/metered/breach

Request

  • Base URL: https://api.relayshield.net
  • URL: https://api.relayshield.net/v1/metered/breach
  • Auth: one of:
    • API key in header X-RS-API-KEY
    • HTTP bearer

Request body

emailstring email required

Email address to check. Case-insensitive; whitespace is trimmed. Must contain '@'.

Example request

{
  "email": "user@example.com"
}

Response

Success. ok is true and data holds the result.

oktrue required

Changes

No recorded changes to this operation across all 1 revision of this API.