The following API endpoints allow you to add, update, delete, and retrieve monitored identities in the Enzoic system, using your API key. Note that you will need to have Identity Breach Monitoring added to your subscription before you can call these APIs. You will also need a webhook configured on your account to receive notifications.
Allows you to set up a new alert subscription for one or more individual identities. This can include many aspects of an individual's PII, such as name, physical address, phone numbers, government IDs, email addresses, credit cards, etc.
POSThttps://api.enzoic.com/v1/identity-monitoring
Authorization
Body
monitoredIdentitiesarray of object
An array of identities to monitor. The max number of identities in a single call is 20.
Response
The call was successful. Your webhook will now be called whenever one of the submitted identities is involved in a new breach.
Body
addedinteger
The number of new alert subscriptions created.
alreadyExistedinteger
The number of alert subscriptions which already existed.
An array of tags for the identities to stop monitoring
idsarray of string
An array of Enzoic IDs for the identities to stop monitoring. These are the id field values which are returned as part of the response object when the /monitored-identities GET endpoint is called.
Response
The call was successful. The provided identities will no longer be monitored.
Body
deletedinteger
The number of monitored identities deleted.
notFoundinteger
The number of provided identities which were not found in the monitored identities table.
Allows you to update an existing monitored identity with new or updated information. For example, you may wish to add additional emails to be monitored, or remove a credit card from monitoring. It is not necessary to resubmit the entire identity; fields which are not present in the PUT body will not get updated. If an array value (such as emails) is specified, it will replace the entire contents of the array. So if the existing monitored identity's emails array contained ["email1@enzoic.com", "email2@enzoic.com"] and the emails array value in the PUT contained ["newemail@enzoic.com"], the new stored array on the monitored identity would be ["newemail@enzoic.com"].
PUThttps://api.enzoic.com/v1/identity-monitoring
Authorization
Body
monitoredIdentitiesarray of object
An array of identities to monitor. The max number of identities in a single call is 20.
Response
The call was successful. The monitored identities have been updated with the new information.
Body
updatedinteger
The number of items updated.
notFoundinteger
The number of items which were not found and could not be updated.
Returns a paginated list of all monitored identities for your account. Can be used to check if a specific identity is monitored by using the tag or id parameters.
GEThttps://api.enzoic.com/v1/identity-monitoring
Authorization
Query parameters
Response
The response body contains the requested results.
Body
countinteger
The total number of monitored identity 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.
monitoredIdentitiesarray of object
An array of monitored identities
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.