curl -X POST "<base_url>/dpp/dbos/v2/scan" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"phone": "string"
}'
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"summary": {
"subject": {
"firstName": "string",
"lastName": "string",
"phone": "string",
"city": "string",
"state": "string",
"zip": "string"
},
"query": "name",
"total": 2,
"found": 1,
"notFound": 1,
"elapsedMs": 14657
},
"found": [
{
"id": "broker-name",
"name": "Broker Name",
"url": "string",
"status": "FOUND",
"optoutStrategy": "form",
"optoutUrl": "https://domain.com/remove-info.php",
"optoutEmail": "[email protected]"
}
],
"notFound": [
{
"id": "broker-name",
"name": "Broker Name",
"status": "NOT_FOUND"
}
]
}
}
Broker Scan
Instant People Search
A one-off lookup that runs a broker probe and returns a minimal response split into two arrays.
POST
/
dpp
/
dbos
/
v2
/
scan
curl -X POST "<base_url>/dpp/dbos/v2/scan" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"phone": "string"
}'
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"summary": {
"subject": {
"firstName": "string",
"lastName": "string",
"phone": "string",
"city": "string",
"state": "string",
"zip": "string"
},
"query": "name",
"total": 2,
"found": 1,
"notFound": 1,
"elapsedMs": 14657
},
"found": [
{
"id": "broker-name",
"name": "Broker Name",
"url": "string",
"status": "FOUND",
"optoutStrategy": "form",
"optoutUrl": "https://domain.com/remove-info.php",
"optoutEmail": "[email protected]"
}
],
"notFound": [
{
"id": "broker-name",
"name": "Broker Name",
"status": "NOT_FOUND"
}
]
}
}
Send a live request to
POST /dpp/dbos/v2/scan with Try it. See the full reference for the response fields and error codes: Instant People Search.
Request Body
string
Required together with lastName for a name scan.
string
Required together with firstName for a name scan.
string
Optional narrowing for a name scan.
string
US state. Optional narrowing for a name scan.
string
Optional narrowing.
string
10-digit phone number for a reverse-phone scan.
string
Optional ISO-2 filter. US selects US brokers only; an EU code (DE, FR, IT, NL, …) selects that country only. Wins over region.
string
Optional region filter. Ignored when country is supplied; unknown values apply no filter.
string[]
Optional list of broker ids to probe, applied after country/region filtering.
curl -X POST "<base_url>/dpp/dbos/v2/scan" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"phone": "string"
}'
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"summary": {
"subject": {
"firstName": "string",
"lastName": "string",
"phone": "string",
"city": "string",
"state": "string",
"zip": "string"
},
"query": "name",
"total": 2,
"found": 1,
"notFound": 1,
"elapsedMs": 14657
},
"found": [
{
"id": "broker-name",
"name": "Broker Name",
"url": "string",
"status": "FOUND",
"optoutStrategy": "form",
"optoutUrl": "https://domain.com/remove-info.php",
"optoutEmail": "[email protected]"
}
],
"notFound": [
{
"id": "broker-name",
"name": "Broker Name",
"status": "NOT_FOUND"
}
]
}
}