> For the complete documentation index, see [llms.txt](https://api-docs.espysys.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-docs.espysys.com/breachscan.md).

# BreachScan

**Endpoint:** <mark style="color:yellow;">POST</mark> <https://irbis.espysys.com/api/developer/deepweb>

Below is a sample request to perform a lookup using the API:

```
{
  "key": "YOUR_API_KEY",
  "value": "SEARCH_VALUE",
  "lookupType": "LOOKUP_TYPE",
  "lookupId": "LOOKUPID_VALUE"
}
```

**Instructions:**

* Replace `YOUR_API_KEY` in the "key" field with your actual API Key.
* For the "value" field, insert with one of the aforementioned search values.
* For the `LOOKUP_TYPE` field, insert one of the following search values:
  * `password`
  * `fullname`
  * `facebookid`
  * `telegramid`
  * `linkedinid`
  * `vkid`
  * `twitterid`
  * `instagramid`
  * `email`
  * `phone`

The  "lookupId" must be set to what is shown in table API lookups types at [Developer page](https://espyosint.ddns.net/developer) or at [API lookup types](/api-lookup-types.md) page

##
