curl -X GET "<base_url>/dpp/dwm/v2/breach/data/emails/{email}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"results": [
{
"username": "string",
"domain": "domain.com",
"passwordType": "plaintext",
"severity": 20,
"ipAddresses": [
"string"
],
"emailUsername": "string",
"passwordPlaintext": "string",
"emailDomain": "domain.com",
"sourceId": 6,
"password": "string",
"email": "string",
"documentId": "00000000-0000-0000-0000-000000000000",
"publishDate": "2016-10-24T00:00:00Z",
"source": {
"id": 6,
"title": "Breach Name",
"shortTitle": "Breach Name",
"category": "unknown",
"type": "PUBLIC",
"site": "domain.com",
"publishDate": "2016-10-24T02:00:25Z"
}
}
],
"page": 1,
"pageSize": 50,
"total": 1
}
}
Dark Web Scan
Get Records by Email
Returns every record in the dark-web breach dataset that exposes the given email address.
GET
/
dpp
/
dwm
/
v2
/
breach
/
data
/
emails
/
{email}
curl -X GET "<base_url>/dpp/dwm/v2/breach/data/emails/{email}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"results": [
{
"username": "string",
"domain": "domain.com",
"passwordType": "plaintext",
"severity": 20,
"ipAddresses": [
"string"
],
"emailUsername": "string",
"passwordPlaintext": "string",
"emailDomain": "domain.com",
"sourceId": 6,
"password": "string",
"email": "string",
"documentId": "00000000-0000-0000-0000-000000000000",
"publishDate": "2016-10-24T00:00:00Z",
"source": {
"id": 6,
"title": "Breach Name",
"shortTitle": "Breach Name",
"category": "unknown",
"type": "PUBLIC",
"site": "domain.com",
"publishDate": "2016-10-24T02:00:25Z"
}
}
],
"page": 1,
"pageSize": 50,
"total": 1
}
}
Send a live request to
GET /dpp/dwm/v2/breach/data/emails/{email} with Try it. See the full reference for the response fields and error codes: Get Records by Email.
Path Parameters
string
required
Email address to look up.
Query Parameters
number
Page number (1-based). 50 records/page over the newest 1000 stored (max 20 pages).
string
Registered user uuid — makes this a PAID lookup. Must belong to your partner (404 if not); a disabled or expired user gives 403. Omit for a free lookup.
curl -X GET "<base_url>/dpp/dwm/v2/breach/data/emails/{email}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"results": [
{
"username": "string",
"domain": "domain.com",
"passwordType": "plaintext",
"severity": 20,
"ipAddresses": [
"string"
],
"emailUsername": "string",
"passwordPlaintext": "string",
"emailDomain": "domain.com",
"sourceId": 6,
"password": "string",
"email": "string",
"documentId": "00000000-0000-0000-0000-000000000000",
"publishDate": "2016-10-24T00:00:00Z",
"source": {
"id": 6,
"title": "Breach Name",
"shortTitle": "Breach Name",
"category": "unknown",
"type": "PUBLIC",
"site": "domain.com",
"publishDate": "2016-10-24T02:00:25Z"
}
}
],
"page": 1,
"pageSize": 50,
"total": 1
}
}