Query Breach Alert Subscriptions for Users

Retrieve current user breach alert subscriptions

get

Returns a paginated list of all user-level alert subscriptions for your account. Can be used to check if a specific user is monitored by using the usernameHash parameter.

Authorizations

Query parameters

includeExtendedInfobooleanOptional

(Optional) If this parameter is specified and true, the results will include the webhook information and custom data for each monitored user.

usernameHashstringOptional

(Optional) If specified, the call will only check to see if this email address is monitored. It consists of a SHA256 hash of the lowercased email address to check. If this parameter is not provided, the call will instead return a list of all emails being monitored for your account.

usernameCustomDatastringOptional

(Optional) If specified, the call will return a list of all emails being monitored for your account that were originally added with this customData value.

pageSizeintegerOptional

(Optional) The number of results to return in a single call

pagingTokenstringOptional

(Optional) For each call to the API, if there are more pages of results available then a pagingToken will be returned. Pass the pagingToken in via this parameter to retrieve the subsequent page of results. Should be left off for the initial call to the API.

Responses

200

The response body contains the requested results.

application/json

404

Returned when the usernameHash parameter is used to indicate that an alert subscription does not exist for the provided email hash.

get

HTTPcURLJavaScriptPython

GET /v1/breach-monitoring-for-users HTTP/1.1
Host: api.enzoic.com
Authorization: Bearer Base64(your_api_key:your_api_secret)
Accept: */*

{
  "count": 1,
  "usernameHashes": [
    {
      "usernameHash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
      "customData": "corporate_users",
      "webhookID": "66766957431c9acc8cea2d6d",
      "webhookURL": "https://mywebhook.com"
    }
  ],
  "pagingToken": "5854757a7750ac6c4230f656"
}