Add Breach Alert Subscriptions for Users

Add user breach alert subscriptions

post

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.

Authorizations

Body

usersToMonitorobject[]required

An array of users you wish to set up breach monitoring for. Maximum number of entries in a single post is 15,000.

webhookIDstringoptional

(Optional) 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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.enzoic.com/v1/breach-monitoring-for-users' \
  --header 'Authorization: Bearer Base64(your_api_key:your_api_secret)' \
  --header 'Content-Type: application/json' \
  --data '{
    "usersToMonitor": [
      {
        "usernameHash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
        "customData": "corporate_users"
      }
    ],
    "webhookID": "66766957431c9acc8cea2d6d"
  }'

201

201

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

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