curl -X GET "<base_url>/dpp/dwm/v2/breach/data/national-ids/{nationalId}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"page": 1,
"pageSize": 50,
"total": 1,
"results": [
{
"nationalId": "string",
"severity": 20,
"sourceId": 131571
}
]
}
}
Dark Web Scan
Get Records by National ID
Returns breach records in the dark-web breach dataset that expose the given national identity number.
GET
/
dpp
/
dwm
/
v2
/
breach
/
data
/
national-ids
/
{nationalId}
curl -X GET "<base_url>/dpp/dwm/v2/breach/data/national-ids/{nationalId}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"page": 1,
"pageSize": 50,
"total": 1,
"results": [
{
"nationalId": "string",
"severity": 20,
"sourceId": 131571
}
]
}
}
Send a live request to
GET /dpp/dwm/v2/breach/data/national-ids/{nationalId} with Try it. See the full reference for the response fields and error codes: Get Records by National ID.
Path Parameters
string
required
National identity number.
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/national-ids/{nationalId}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"page": 1,
"pageSize": 50,
"total": 1,
"results": [
{
"nationalId": "string",
"severity": 20,
"sourceId": 131571
}
]
}
}