curl -X GET "<base_url>/dpp/dbos/v2/brokers" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"data": [
{
"brokerId": 288,
"name": "Broker Name",
"category": "people-search",
"optOutUrl": "https://domain.com/removal",
"website": "https://domain.com",
"requiredFields": [
"first_name",
"last_name",
"email"
],
"type": "public",
"informationCollected": [
"name",
"location"
],
"riskScore": 5,
"privacyPolicyUrl": "",
"supportEmail": "[email protected]",
"ccpaCompliant": true,
"gdprCompliant": false,
"region": "US",
"country": "string",
"address": "string",
"contact": "string",
"averageResponseTime": "string",
"logoUrl": "https://domain.com/logos/broker-name.png"
}
],
"total": 1,
"page": 1,
"pageSize": 100
}
}
Broker Catalog
List Brokers
The data broker catalogue, a page at a time.
GET
/
dpp
/
dbos
/
v2
/
brokers
curl -X GET "<base_url>/dpp/dbos/v2/brokers" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"data": [
{
"brokerId": 288,
"name": "Broker Name",
"category": "people-search",
"optOutUrl": "https://domain.com/removal",
"website": "https://domain.com",
"requiredFields": [
"first_name",
"last_name",
"email"
],
"type": "public",
"informationCollected": [
"name",
"location"
],
"riskScore": 5,
"privacyPolicyUrl": "",
"supportEmail": "[email protected]",
"ccpaCompliant": true,
"gdprCompliant": false,
"region": "US",
"country": "string",
"address": "string",
"contact": "string",
"averageResponseTime": "string",
"logoUrl": "https://domain.com/logos/broker-name.png"
}
],
"total": 1,
"page": 1,
"pageSize": 100
}
}
The data broker catalogue, a page at a time. Only brokers that are actively covered are listed. brokerId is the same id used by GET /dpp/dbos/v2/brokers/{brokerId}, by broker assignments and in user status. 100 brokers per page by default and at most 100; the response echoes the page size used. logoUrl is valid for 7 days and created per request: show it, never store it.
See Errors for the response envelope and the full list of codes.
- URL:
/dpp/dbos/v2/brokers - Full URL:
<base_url>/dpp/dbos/v2/brokers - Request Method: GET
Authentication
Send the Access Token in theX-AccessToken request header on every authenticated call:
X-AccessToken: YOUR_ACCESS_TOKEN
Query Parameters
number
Page number (1-based).
number
Items per page. Default 100, maximum 100.
Sample Request
cURL
curl -X GET "<base_url>/dpp/dbos/v2/brokers" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
curl -X GET "<base_url>/dpp/dbos/v2/brokers" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
Response
object
object
Show body
Show body
object[]
Show data
Show data
number
The same id used by broker assignments and user status.
string
string
string
string
string[]
string
string[]
number
string
string
boolean
boolean
string
string
string
string
string
string
Viewable URL valid for 7 days, created per request: show it, never store it. Null when the broker has no logo.
number
Total number of matching records across all pages.
number
Current page number.
number
Number of records per page.
Sample Response
Success
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"data": [
{
"brokerId": 288,
"name": "Broker Name",
"category": "people-search",
"optOutUrl": "https://domain.com/removal",
"website": "https://domain.com",
"requiredFields": [
"first_name",
"last_name",
"email"
],
"type": "public",
"informationCollected": [
"name",
"location"
],
"riskScore": 5,
"privacyPolicyUrl": "",
"supportEmail": "[email protected]",
"ccpaCompliant": true,
"gdprCompliant": false,
"region": "US",
"country": "string",
"address": "string",
"contact": "string",
"averageResponseTime": "string",
"logoUrl": "https://domain.com/logos/broker-name.png"
}
],
"total": 1,
"page": 1,
"pageSize": 100
}
}
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"data": [
{
"brokerId": 288,
"name": "Broker Name",
"category": "people-search",
"optOutUrl": "https://domain.com/removal",
"website": "https://domain.com",
"requiredFields": [
"first_name",
"last_name",
"email"
],
"type": "public",
"informationCollected": [
"name",
"location"
],
"riskScore": 5,
"privacyPolicyUrl": "",
"supportEmail": "[email protected]",
"ccpaCompliant": true,
"gdprCompliant": false,
"region": "US",
"country": "string",
"address": "string",
"contact": "string",
"averageResponseTime": "string",
"logoUrl": "https://domain.com/logos/broker-name.png"
}
],
"total": 1,
"page": 1,
"pageSize": 100
}
}
Status Codes
| Status | Meaning |
|---|---|
200 | One page of brokers. |
400 | 10002: page or pageSize is below 1. |
500 | Internal Server Error. |
Error codes
Returned inheader.response_code when the request fails.
| Code | Message |
|---|---|
10002 | page or pageSize is below 1. |