Documentation for Product Version:

Account Status API

The Account Status API allows you to query the current usage of your Enzoic (formerly PasswordPing) account.

Available Calls

  • GET Account Status
    Returns basic API usage stats for your account for the current billing period.
  • GET Account Usage
    Returns extended API usage stats for your account for the specified month and year, including efficacy reporting.

GET – Account Status

https://api.enzoic.com/account-status

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.

See Using Enzoic for general instructions on using the API.

Request

No request parameters required.

Response

Response Description
200 The response contains current usage statistics.

Response Body

Member Type Description
monthlyAPICallLimit integer How many calls your account is allowed to make to the Enzoic API every month
currentAPICallUsage integer How many calls have been made in the current billing period
exposureAlertsServiceMonitoredAccountsLimit integer How many email accounts your account is allowed to monitor for new exposures
exposureAlertsServiceCurrentMonitoredAccounts integer How many email accounts your account is currently monitoring for new exposures
exposureAlertsServiceMonitoredDomainsLimit integer How many email domains your account is allowed to monitor for new exposures
exposureAlertsServiceCurrentMonitoredDomains integer How many email domains your account is currently monitoring for new exposures

Example

Request
curl --header "authorization: basic {your auth string}" "https://api.enzoic.com/account-status"
Response
{ 
  "monthlyAPICallLimit": 500000,
  "currentAPICallUsage": 200635,
  "exposureAlertsServiceMonitoredAccountsLimit": 100,
  "exposureAlertsServiceCurrentMonitoredAccounts": 2,
  "exposureAlertsServiceMonitoredDomainsLimit": 3,
  "exposureAlertsServiceCurrentMonitoredDomains": 1
}

GET – Account Usage

https://api.enzoic.com/account-usage

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.

See Using Enzoic for general instructions on using the API.

Request

Parameter Type Description
month int The numeric month you wish to retrieve data for (1-12)
year int The full year you wish to retrieve data for (e.g. 2019)

Response

Response Description
200 The response contains specified usage statistics.

Response Body

Member Type Description
apiCallUsage integer The total number of API calls made on your account
passwordAPICalls integer The number of Passwords API calls made during the specified billing period
passwordAPIMatches integer 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.
credentialsAPICalls integer The number of Credentials API checks made during the specified billing period
credentialsAPIMatches integer 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.
exposuresAPICalls integer The number of Exposures API calls made during the specified billing period
exposuresAPIMatches integer The number of matches returned by the Exposures API during the specified billing period.

Example

Request
curl --header "authorization: basic {your auth string}" "https://api.enzoic.com/account-usage?month=4&year=2019"
Response
{ 
    "apiCallUsage": 443644,
    "passwordAPICalls": 438364,
    "passwordAPIMatches": 344697,
    "credentialsAPICalls": 120831,
    "credentialsAPIMatches": 10219,
    "exposuresAPICalls": 23099,
    "exposuresAPIMatches": 17833
}