Breach Monitoring by Domain

Get notified when a new breach is found containing the emails from a monitored domain

Add Breach Alert Subscriptions

Subscribe to Exposure alerts for a domain

Allows you to set up a new Exposure alert subscription for one or more email domains. Note that you must be pre-approved and verified to subscribe for the domain(s) you are registering. Please Contact Us for assistance.

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

Authorization

enzoic_auth

Body

application/json

domainsarray of string

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.

alreadyExistedinteger

The number of alert subscriptions which already existed.

Request

JavaScriptCurl

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

Response

{
  "added": 1
}

Remove Breach Alert Subscriptions

Delete Exposure alert subscriptions for one or more domains.

Allows you to delete Exposure alert subscriptions for one or more email domains.

DELETEhttps://api.enzoic.com/v1/breach-monitoring-for-domains

Authorization

enzoic_auth

Body

application/json

domainarray of string

Response

200

The call was successful. You will no longer receive alerts for the provided domains.

Body

application/json

deletedinteger

The number of alert subscriptions deleted.

notFoundinteger

The number of provided domains which were not found in the alert subscriptions table.

Request

JavaScriptCurl

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

Response

{
  "deleted": 1
}

Retrieve Current Breach Alert Subscriptions

Retrieve Exposure alert subscriptions for domains

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

GEThttps://api.enzoic.com/v1/breach-monitoring-for-domains

Authorization

enzoic_auth

Query parameters

Response

200404

The response body contains the requested results.

Body

application/json

countinteger

The total number of domain alert subscription records available across all pages. If this exceeds the requested page size, the results are paginated and a pagingToken will be present in the response.

domainsarray of string

pagingTokenstring

Present when there are additional pages of results available. Pass this token in on a subsequent call to fetch the next page of results.

Request

JavaScriptCurl

const response = await fetch('https://api.enzoic.com/v1/breach-monitoring-for-domains', {
    method: 'GET',
    headers: {
      "Authorization": "basic <token>"
    },
});
const data = await response.json();

Response

{
  "count": 1,
  "domains": [
    "sample.tst"
  ],
  "pagingToken": "5854757a7750ac6c4230f656"
}