Add Breach Alert Subscriptions for Users

Add user breach alert subscriptions

Allows you to set up a new exposure alert subscription for one or more email addresses. For additional privacy and security, emails are submitted as SHA256 hashes.

POSThttps://api.enzoic.com/v1/breach-monitoring-for-users

Authorization

enzoic_auth

Body

application/json

usernameHashes*array of string

An array of SHA256 hashes of the lowercased email addresses you wish to set up breach monitoring for. Maximum number of entries in a single post is 15,000.

customDatastring

An optional unique identifier you would like assigned to the monitored usernames for later retrieval and reference. It will be passed in via alert notifications to your webhook when one of these usernames is found in a breach.

Example: "corporate_users"

webhookIDstring

The ID of the webhook to send alerts to when new Exposures are found related to this user. If not specified, the default webhook for your account will be used.

Example: "66766957431c9acc8cea2d6d"

Response

201

The call was successful. Your webhook will now be called whenever one of the submitted email addresses is involved in a new Exposure.

Body

application/json

addedinteger

The number of new alert subscriptions created.

Example: 1

alreadyExistedinteger

The number of alert subscriptions which already existed.

Example: 0

Request

JavaScriptCurlPython

const response = await fetch('https://api.enzoic.com/v1/breach-monitoring-for-users', {
    method: 'POST',
    headers: {
      "Authorization": "basic <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "usernameHashes": [
        "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
      ]
    }),
});
const data = await response.json();

Response

201

{
  "added": 1,
  "alreadyExisted": 0
}