curl -X GET "<base_url>/dpp/dbos/v2/users/{profileId}/screenshot?key={key}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"url": "string",
"expiresInSeconds": 3600
}
}
Evidence Based Scan
Retrieve Screenshots
Returns a 1-hour URL for a screenshot.
GET
/
dpp
/
dbos
/
v2
/
users
/
{profileId}
/
screenshot
curl -X GET "<base_url>/dpp/dbos/v2/users/{profileId}/screenshot?key={key}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"url": "string",
"expiresInSeconds": 3600
}
}
Returns a 1-hour URL for a screenshot. Pass a key from a broker’s evidence.scanScreenshotKey or evidence.removalScreenshotKey in GET /dpp/dbos/v2/users/{profileId}/status.
See Errors for the response envelope and the full list of codes.
- URL:
/dpp/dbos/v2/users/{profileId}/screenshot - Full URL:
<base_url>/dpp/dbos/v2/users/{profileId}/screenshot - 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
The profileId supplied when the user was created.
Query Parameters
string
required
Screenshot key from the evidence object.
Sample Request
cURL
curl -X GET "<base_url>/dpp/dbos/v2/users/{profileId}/screenshot?key={key}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
curl -X GET "<base_url>/dpp/dbos/v2/users/{profileId}/screenshot?key={key}" \
-H "X-AccessToken: YOUR_ACCESS_TOKEN"
Response
object
object
Sample Response
Success
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"url": "string",
"expiresInSeconds": 3600
}
}
{
"header": {
"message": "Success",
"response_code": 1
},
"body": {
"url": "string",
"expiresInSeconds": 3600
}
}
Status Codes
| Status | Meaning |
|---|---|
200 | URL returned (valid 3600 seconds). |
400 | 10204: key query parameter missing. |
401 | 10103: the calling account is not an active Data Broker Opt-Out partner. |
500 | Internal Server Error. |
Error codes
Returned inheader.response_code when the request fails.
| Code | Message |
|---|---|
10103 | The calling account is not an active Data Broker Opt-Out partner. |
10204 | key query parameter missing. |