Account Status APIs

The Account Status APIs allow you to query status and usage for your Enzoic account.

Available Calls

Account Status

Returns basic API usage stats for your account for the current billing period.

The Account Status API allows you to query the current usage of your Enzoic account. Returns basic API usage stats for your account for the current billing period. Note that current usage numbers may be up to 5 minutes behind.

GEThttps://api.enzoic.com/v1/account-status

Authorization

enzoic_auth

Response

200

The response contains current usage statistics.

Body

application/json

monthlyAPICallLimitinteger

How many calls your account is allowed to make to the Enzoic API every month

currentAPICallUsageinteger

How many calls have been made in the current billing period

exposureAlertsServiceMonitoredAccountsLimitinteger

How many email accounts your account is allowed to monitor for new exposures

exposureAlertsServiceCurrentMonitoredAccountsinteger

How many email accounts your account is currently monitoring for new exposures

exposureAlertsServiceMonitoredDomainsLimitinteger

How many email domains your account is allowed to monitor for new exposures

exposureAlertsServiceCurrentMonitoredDomainsinteger

How many email domains your account is currently monitoring for new exposures

Request

JavaScriptCurl

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

Response

{
  "monthlyAPICallLimit": 20000,
  "currentAPICallUsage": 1022,
  "exposureAlertsServiceMonitoredAccountsLimit": 10,
  "exposureAlertsServiceCurrentMonitoredAccounts": 8,
  "exposureAlertsServiceMonitoredDomainsLimit": 1,
  "exposureAlertsServiceCurrentMonitoredDomains": 1
}

Account Usage

Returns extended API usage stats for your account for the specified month and year, including efficacy reporting.

Returns extended API usage stats for your account for the specified month and year, including efficacy reporting. Note that current usage numbers may be up to 5 minutes behind.

GEThttps://api.enzoic.com/v1/account-usage

Authorization

enzoic_auth

Query parameters

Response

200

The response contains requested usage statistics.

Body

application/json

apiCallUsageinteger

The total number of API calls made on your account

passwordAPICallsinteger

The number of Passwords API calls made during the specified billing period

passwordAPIMatchesinteger

The number of matches returned by the Passwords API during the specified billing period. This can be used as a rough estimate for what percentage of the time a password was rejected.

credentialsAPICallsinteger

The number of Credentials API checks made during the specified billing period

credentialsAPIMatchesinteger

The number of matches returned by the Credentials API during the specified billing period. This can be used as a rough estimate for what percentage of the time a set of credentials was found to be compromised.

exposuresAPICallsinteger

The number of Exposures API calls made during the specified billing period

exposuresAPIMatchesinteger

The number of matches returned by the Exposures API during the specified billing period.

Request

JavaScriptCurl

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

Response

{
  "apiCallUsage": 443644,
  "passwordAPICalls": 438364,
  "passwordAPIMatches": 344697,
  "credentialsAPICalls": 120831,
  "credentialsAPIMatches": 10219,
  "exposuresAPICalls": 23099,
  "exposuresAPIMatches": 17833
}