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

enzoic_auth

AuthorizationstringRequired

The Enzoic API uses a basic auth scheme where the username is your API key and the password is your API secret.
See https://docs.enzoic.com/enzoic-api-developer-documentation/using-the-enzoic-api#api-authentication for more details.

Body

application/json

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

201

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

application/json

post

/breach-monitoring-for-users

HTTPcURLJavaScriptPython

POST /v1/breach-monitoring-for-users HTTP/1.1
Host: api.enzoic.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 174

{
  "usersToMonitor": [
    {
      "usernameHash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
      "customData": "corporate_users"
    }
  ],
  "webhookID": "66766957431c9acc8cea2d6d"
}

201

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

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