Get Individual Dark Web Data

This API will get all dark web information that's known about an individual employee (updates every 24 hours).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Response Fields Explained:

  • EmailAddress: The employee email address that has been queried for data breaches
  • BreachAddressed: True or false statement on whether this employee has been marked as notified within the CanIPhish Cloud Platform.
  • LastModified: The UTC DateTime of when the latest data breach was discovered for this employee, formatted as an ISO 8601 string (e.g. "2024-03-05T05:55:33").
  • BreachData: The breach model which contains a number of attributes describing the breach.
    • Name: String value representing the unique name associated to this breach
    • Title: A descriptive title for the breach suitable for displaying to end users.
    • Domain: The domain of the primary website the breach occurred on.
    • BreachDate: The date (with no time) the breach originally occurred on in ISO 8601 format.
    • AddedDate: The date and time (precision to the minute) the breach was added to the system in ISO 8601 format.
    • ModifiedDate: The date and time (precision to the minute) the breach was modified in ISO 8601 format.
    • PwnCount: The total number of accounts loaded into the system that was breached.
    • Description: Contains an overview of the breach represented in HTML markup.
    • DataClasses: This attribute describes the nature of the data compromised in the breach and contains an alphabetically ordered string array of impacted data classes.
    • IsVerified: Indicates that the breach is considered unverified. An unverified breach may not have been hacked from the indicated website.
    • IsFabricated: Indicates that the breach is considered fabricated. A fabricated breach is unlikely to have been hacked from the indicated website and usually contains a large amount of manufactured data.
    • IsSensitive: Indicates if the breach is considered sensitive.
    • IsRetired: Indicates if the breach has been retired.
    • IsSpamList: Indicates if the breach is considered a spam list.
    • LogoPath: A URI that specifies where a logo for the breached service can be found. Logos are always in PNG format.

Notes:

  1. Dark web monitoring must be enabled on your CanIPhish tenant for this API to function. If disabled, no data will be returned.
  2. Have I Been Pwned is a subprocessor of CanIPhish, and all information provided from this API has been collected from Have I Been Pwned. For live information, you can use the Have I Been Pwned API.
Body Params
string

The CanIPhish tenant to pull information from.

string

The email address of the employee that will be checked to see if they've been involved in a dark web data breach.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json