curl -X GET "<base_url>/dpp/dbos/v2/brokers/{brokerId}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"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"
}
}
Broker Catalog
Get Broker by ID
One broker by its brokerId, in the same shape as the list.
GET
/
dpp
/
dbos
/
v2
/
brokers
/
{brokerId}
curl -X GET "<base_url>/dpp/dbos/v2/brokers/{brokerId}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"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"
}
}
One broker by its brokerId, in the same shape as the list. An id that is not in the list returns 10300. logoUrl is valid for 7 days.
See Errors for the response envelope and the full list of codes.
- URL:
/dpp/dbos/v2/brokers/{brokerId} - Full URL:
<base_url>/dpp/dbos/v2/brokers/{brokerId} - Request Method: GET
Authentication
Send the Access Token in theX-AccessToken request header on every authenticated call:
X-AccessToken: YOUR_ACCESS_TOKEN
Path Parameters
number
required
The broker id (brokerId in every v2 response).
Sample Request
cURL
curl -X GET "<base_url>/dpp/dbos/v2/brokers/{brokerId}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
curl -X GET "<base_url>/dpp/dbos/v2/brokers/{brokerId}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
Response
object
object
Show body
Show body
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.
Sample Response
Success
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"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"
}
}
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"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"
}
}
Status Codes
| Status | Meaning |
|---|---|
200 | The broker. |
400 | 10006: brokerId is not a number. |
404 | 10300: no active broker with this id. |
500 | Internal Server Error. |
Error codes
Returned inheader.response_code when the request fails.
| Code | Message |
|---|---|
10006 | brokerId is not a number. |
10300 | No active broker with this id. |