# Getting Started

Enzoic has a series of simple hosted REST APIs which allow you to harness the power of our massive database of compromised credentials and accounts for integration into your application or website.

While any of our APIs are callable directly, by far the easiest way to get started using Enzoic is to use one of our rich suite of [libraries](libraries) that you can use within your applications. We offer a series of Quick Start tutorials for each.

You can download a Postman collection with a set of example API calls [here](https://cdn.enzoic.com/enzoic-api-examples.postman_collection.json)

The full OpenAPI spec for the Enzoic API is available for [download](https://cdn.enzoic.com/enzoicapi.yaml), or you can [view the OpenAPI spec using the Swagger UI](https://petstore.swagger.io/?url=https://cdn.enzoic.com/enzoicapi.yaml).

Enzoic consists of the following:

<details>

<summary><a href="api-reference/passwords-api">Passwords API</a></summary>

Lookup whether a given password exists in our database of compromised passwords.

#### Typical Use Case:&#x20;

Integration into account signup forms and password change forms to alert users if they enter a known compromised password in order to ensure users aren’t using exposed passwords that cybercriminals routinely include in password cracking dictionaries.

</details>

<details>

<summary><a href="api-reference/credentials-api">Credentials API</a></summary>

Securely lookup whether a given username/password combination exists in our database of compromised account credentials.

#### Typical Use Case:&#x20;

As users log into a website or application, their credentials are checked against this API and, if compromised, the login can be blocked and redirected into a password reset flow. This prevents cybercriminals from logging in using stolen credentials.

</details>

<details>

<summary><a href="api-reference/credentials-api/cleartext-credentials-api">Cleartext Credentials API</a></summary>

Securely lookup all the compromised passwords Enzoic has for a given user. The passwords are returned in cleartext, if available, or in the raw hash format that was recovered.

#### **Typical Use Case:**&#x20;

A user’s credentials are periodically checked offline to determine if they are compromised. Note: This API is extremely sensitive and restricted to organizations that pass extensive vetting. Please [contact sales](https://www.enzoic.com/contact-us/) if you believe you have an appropriate use case for this API.

</details>

<details>

<summary><a href="api-reference/exposures-api">Exposures API</a></summary>

Lookup what exposures a given email address or domain has been involved in.

#### Typical Use Case:&#x20;

Periodic scans across your user base can determine if one of your users has been involved in any new exposures. If so, a notification can be sent to the user and potentially a password reset required.

</details>

<details>

<summary><a href="api-reference/breach-monitoring-api">Breach Monitoring API</a></summary>

Allows you to register email addresses (or domain) so that you will be notified when a new exposure of that address occurs. Notification occurs via a POST to a webhook URL you specify.

#### **Typical Use Case:**&#x20;

Proactive notification about whether your users are involved in a new exposure provides a way to enrich your threat intelligence and allow immediate notification the moment a new exposure is found.

</details>

<details>

<summary><a href="api-reference/identity-breach-monitoring-api">Identity Breach Monitoring API</a></summary>

Allows you to register an individual's identity by submitting relevant personally identifiable information (PII) and financial data for monitoring.  You will be notified when a new exposure of any portion of that PII occurs.  Notification occurs via a POST to a webhook URL you specify.

#### **Typical Use Case:**&#x20;

Proactive notification about whether your users' identities are involved in a new exposure provides a way to prevent fraud, identity theft and exploitation.

</details>

<details>

<summary><a href="api-reference/bin-monitoring-api">BIN Monitoring API</a></summary>

Allows you to register your financial institution's Bank Identification Numbers (BINs) for monitoring.  You will be notified when a new exposure of any credit card associated with one of the monitored BINs occurs.  Notification occurs via a POST to a webhook URL you specify.

#### **Typical Use Case:**&#x20;

Prevent fraudulent usage of your institution's issued credit cards by intercepting the exposure of a stolen number the moment it is shared online.  Newly found numbers will typically be posted to you within seconds of being recovered by Enzoic.

</details>

<details>

<summary><a href="libraries">Libraries</a></summary>

The easiest way to use Enzoic. We have libraries available for most major development languages. If you don’t see the one you’re looking for, give us a shout. We’ll be happy to add it for you!

</details>

<details>

<summary><a href="password-strength-meter">Password Strength Meter</a></summary>

A JavaScript library which allows you to easily replace the password strength meter on your website’s signup form or password change form with one that leverages the Passwords API.

</details>

Unless otherwise noted, all APIs are implemented as REST web services with JSON responses.

Register for a free [API Key](https://console.enzoic.com/register/).

\
\
