curl -X GET "<base_url>/dpp/dwm/v2/user-exposure/phone/{phone}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"firstName": [
"string"
],
"lastName": "string",
"fullName": "string",
"phone": [
"string"
],
"email": "string",
"city": [
"string"
],
"state": [
"string"
],
"zip": [
"string"
],
"country": "UNITED STATES",
"ipAddresses": "string"
}
}
ID Enrichment
Get User Exposure by Phone Number
Pulls every breach record exposing the given phone number and collapses them into ONE profile (one field per key, arrays for multiple distinct values).
GET
/
dpp
/
dwm
/
v2
/
user-exposure
/
phone
/
{phone}
curl -X GET "<base_url>/dpp/dwm/v2/user-exposure/phone/{phone}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"firstName": [
"string"
],
"lastName": "string",
"fullName": "string",
"phone": [
"string"
],
"email": "string",
"city": [
"string"
],
"state": [
"string"
],
"zip": [
"string"
],
"country": "UNITED STATES",
"ipAddresses": "string"
}
}
Pulls every breach record exposing the given phone number and collapses them into ONE profile (one field per key, arrays for multiple distinct values). NOTE: phone numbers can be shared across people, so a phone exposure may blend identities — email is the stronger selector. Credentials (passwords) are excluded.
See Errors for the response envelope and the full list of codes.
- URL:
/dpp/dwm/v2/user-exposure/phone/{phone} - Full URL:
<base_url>/dpp/dwm/v2/user-exposure/phone/{phone} - Request Method: GET
Authentication
Send the Access Token in theX-AccessToken request header on every authenticated call:
X-AccessToken: YOUR_ACCESS_TOKEN
Path Parameters
string
required
Phone number, digits only (no spaces/dashes)
Query Parameters
string
Registered user uuid — makes this a PAID lookup; the user must belong to your partner. Omit for a free lookup.
Sample Request
cURL
curl -X GET "<base_url>/dpp/dwm/v2/user-exposure/phone/{phone}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
curl -X GET "<base_url>/dpp/dwm/v2/user-exposure/phone/{phone}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
Response
object
Sample Response
Success
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"firstName": [
"string"
],
"lastName": "string",
"fullName": "string",
"phone": [
"string"
],
"email": "string",
"city": [
"string"
],
"state": [
"string"
],
"zip": [
"string"
],
"country": "UNITED STATES",
"ipAddresses": "string"
}
}
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"firstName": [
"string"
],
"lastName": "string",
"fullName": "string",
"phone": [
"string"
],
"email": "string",
"city": [
"string"
],
"state": [
"string"
],
"zip": [
"string"
],
"country": "UNITED STATES",
"ipAddresses": "string"
}
}
Status Codes
| Status | Meaning |
|---|---|
200 | A single deduped exposure profile (the body is the profile). |
403 | Paid (uuid query): user disabled (10204) or expired (10205) |
404 | Paid (uuid query): no such user for your partner (10200) |
500 | Internal Server Error. |
Error codes
Returned inheader.response_code when the request fails.
| Code | Message |
|---|---|
10006 | Bad request / A {kind} value is required / Provide at least one search asset |
10200 | User with uuid {uuid} not found |
10204 | User with uuid {uuid} is disabled |
10205 | User with uuid {uuid} has expired |
11100 | Cluster1 is not configured |
11102 | Exposure lookup not permitted ({status}) |
11103 | Exposure lookup returned {status} |
11104 | Cluster1 is unavailable |
11199 | DWM response post-processing failed |