Evidence Based Scan

curl -X GET "<base_url>/dpp/dbos/v2/users/{profileId}/status" \
  -H "X-AccessToken: YOUR_ACCESS_TOKEN"

{
  "header": {
    "message": "Success",
    "response_code": 1
  },
  "body": {
    "profile": {
      "id": "00000000-0000-0000-0000-000000000000",
      "firstName": "string",
      "lastName": "string",
      "phone": "string",
      "email": "string",
      "signed": true,
      "createdAt": "2026-09-28T09:12:44.000Z"
    },
    "cycle": {
      "number": 1,
      "current": true,
      "currentCycle": 1,
      "totalCycles": 1,
      "startedAt": "2026-09-28T09:12:50.000Z",
      "endsAt": "2026-11-27T09:20:11.000Z",
      "closedAt": "string"
    },
    "brokers": [
      {
        "brokerId": 128,
        "brokerSlug": "broker-name",
        "brokerName": "Broker Name",
        "logoUrl": "https://domain.com/logos/broker-name.png",
        "type": "public",
        "category": "people-search",
        "cycle": 1,
        "scanStatus": "PROFILE_FOUND",
        "removalStatus": "REQUEST_SUBMITTED",
        "statusUpdatedAt": "2026-09-28T10:02:11.000Z",
        "action": null,
        "timeline": [
          {
            "step": "REQUEST_SUBMITTED",
            "label": "Submitted",
            "state": "current",
            "at": "2026-09-28T10:02:11.000Z"
          }
        ],
        "missingFields": [],
        "evidence": {
          "scanScreenshotKey": "evidence/.../1759053731000.png",
          "removalScreenshotKey": "evidence/.../1759054011000.png"
        },
        "matchedRecord": {},
        "matchConfidence": "matched",
        "matchListingCount": 1,
        "removedAt": "string",
        "enabled": true
      }
    ],
    "summary": {
      "total": 1,
      "inProgress": 1,
      "actionRequired": 0,
      "completed": 0,
      "notFound": 0,
      "found": 1
    }
  }
}

GET

dpp

dbos

users

{profileId}

status

curl -X GET "<base_url>/dpp/dbos/v2/users/{profileId}/status" \
  -H "X-AccessToken: YOUR_ACCESS_TOKEN"

{
  "header": {
    "message": "Success",
    "response_code": 1
  },
  "body": {
    "profile": {
      "id": "00000000-0000-0000-0000-000000000000",
      "firstName": "string",
      "lastName": "string",
      "phone": "string",
      "email": "string",
      "signed": true,
      "createdAt": "2026-09-28T09:12:44.000Z"
    },
    "cycle": {
      "number": 1,
      "current": true,
      "currentCycle": 1,
      "totalCycles": 1,
      "startedAt": "2026-09-28T09:12:50.000Z",
      "endsAt": "2026-11-27T09:20:11.000Z",
      "closedAt": "string"
    },
    "brokers": [
      {
        "brokerId": 128,
        "brokerSlug": "broker-name",
        "brokerName": "Broker Name",
        "logoUrl": "https://domain.com/logos/broker-name.png",
        "type": "public",
        "category": "people-search",
        "cycle": 1,
        "scanStatus": "PROFILE_FOUND",
        "removalStatus": "REQUEST_SUBMITTED",
        "statusUpdatedAt": "2026-09-28T10:02:11.000Z",
        "action": null,
        "timeline": [
          {
            "step": "REQUEST_SUBMITTED",
            "label": "Submitted",
            "state": "current",
            "at": "2026-09-28T10:02:11.000Z"
          }
        ],
        "missingFields": [],
        "evidence": {
          "scanScreenshotKey": "evidence/.../1759053731000.png",
          "removalScreenshotKey": "evidence/.../1759054011000.png"
        },
        "matchedRecord": {},
        "matchConfidence": "matched",
        "matchListingCount": 1,
        "removedAt": "string",
        "enabled": true
      }
    ],
    "summary": {
      "total": 1,
      "inProgress": 1,
      "actionRequired": 0,
      "completed": 0,
      "notFound": 0,
      "found": 1
    }
  }
}

Each broker has a scanStatus (SCAN_QUEUED: not checked yet; PROFILE_FOUND; PROFILE_NOT_FOUND: nothing to remove; null for private brokers, which are handled without a search) and a removalStatus (REQUEST_QUEUED: being prepared; REQUEST_SUBMITTED: sent to the broker; AWAITING_RESPONSE; ACTION_REQUIRED: the broker emailed the customer a verification link, see action; VERIFYING; COMPLETED; null when there is nothing to remove). timeline is the broker’s removal track, ready to draw as a step tracker in the order given: each step has step, label, state (done, current, upcoming) and at (null for an upcoming step). Public brokers that were found: Request queued, Submitted, Verifying, Completed. Private brokers: Request queued, Submitted, Completed. Not found, or search not finished: an empty timeline. When the customer has done what action asks, call POST /dpp/dbos/v2/users/{profileId}/confirm-action. missingFields lists details a REQUEST_QUEUED removal needs; send them with PATCH /dpp/dbos/v2/users/{profileId} (first_name/last_name: firstName/lastName; address: address1; state: stateCode for a US profile; date_of_birth: dateOfBirth; email, phone, city and zip by the same name). evidence holds screenshot keys for GET /dpp/dbos/v2/users/{profileId}/screenshot. Cycles: removal repeats every 60 days. Without cycle you get the current view, where each broker shows its latest result from whichever cycle it came from (its own cycle field); with cycle=N you get exactly cycle N, and a past cycle lists only the brokers it handled.

Each broker in brokers carries its screenshot keys in evidence (scanScreenshotKey, removalScreenshotKey). Pass one to Retrieve Screenshots to get the evidence image for that broker.

URL: /dpp/dbos/v2/users/{profileId}/status
Full URL: <base_url>/dpp/dbos/v2/users/{profileId}/status
Request Method: GET

Authentication

Send the Access Token in the X-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

number

Return exactly this cycle (1, 2, …). Omit for the current view.

Sample Request

cURL

curl -X GET "<base_url>/dpp/dbos/v2/users/{profileId}/status" \
  -H "X-AccessToken: YOUR_ACCESS_TOKEN"

curl -X GET "<base_url>/dpp/dbos/v2/users/{profileId}/status" \
  -H "X-AccessToken: YOUR_ACCESS_TOKEN"

Response

object

Response header. The gateway always answers HTTP 200: read response_code for the outcome (1 = success). On an error the body is empty.

Show header

string

Response status message, e.g. Success.

number

Result code. 1 = success.

object

Show body

object

Show profile

string

boolean

string

object

Which cycle this response describes and when it ran.

Show cycle

number

boolean

number

string

object[]

Show brokers

number

string

Viewable URL; null when the broker has no logo.

string

number

The cycle this broker’s result came from.

string

object

Set only while removalStatus is ACTION_REQUIRED; null otherwise.

Show action

string

object[]

Show timeline

string

string[]

object

Show evidence

string

object

string

number

string

boolean

object

Two overlapping facets, so do not add them together: found / notFound count scan results (public brokers only); inProgress / actionRequired / completed count removal progress (inProgress also includes brokers whose scan is still queued). total is the number of brokers.

Show summary

number

Sample Response

Success

{
  "header": {
    "message": "Success",
    "response_code": 1
  },
  "body": {
    "profile": {
      "id": "00000000-0000-0000-0000-000000000000",
      "firstName": "string",
      "lastName": "string",
      "phone": "string",
      "email": "string",
      "signed": true,
      "createdAt": "2026-09-28T09:12:44.000Z"
    },
    "cycle": {
      "number": 1,
      "current": true,
      "currentCycle": 1,
      "totalCycles": 1,
      "startedAt": "2026-09-28T09:12:50.000Z",
      "endsAt": "2026-11-27T09:20:11.000Z",
      "closedAt": "string"
    },
    "brokers": [
      {
        "brokerId": 128,
        "brokerSlug": "broker-name",
        "brokerName": "Broker Name",
        "logoUrl": "https://domain.com/logos/broker-name.png",
        "type": "public",
        "category": "people-search",
        "cycle": 1,
        "scanStatus": "PROFILE_FOUND",
        "removalStatus": "REQUEST_SUBMITTED",
        "statusUpdatedAt": "2026-09-28T10:02:11.000Z",
        "action": null,
        "timeline": [
          {
            "step": "REQUEST_SUBMITTED",
            "label": "Submitted",
            "state": "current",
            "at": "2026-09-28T10:02:11.000Z"
          }
        ],
        "missingFields": [],
        "evidence": {
          "scanScreenshotKey": "evidence/.../1759053731000.png",
          "removalScreenshotKey": "evidence/.../1759054011000.png"
        },
        "matchedRecord": {},
        "matchConfidence": "matched",
        "matchListingCount": 1,
        "removedAt": "string",
        "enabled": true
      }
    ],
    "summary": {
      "total": 1,
      "inProgress": 1,
      "actionRequired": 0,
      "completed": 0,
      "notFound": 0,
      "found": 1
    }
  }
}

{
  "header": {
    "message": "Success",
    "response_code": 1
  },
  "body": {
    "profile": {
      "id": "00000000-0000-0000-0000-000000000000",
      "firstName": "string",
      "lastName": "string",
      "phone": "string",
      "email": "string",
      "signed": true,
      "createdAt": "2026-09-28T09:12:44.000Z"
    },
    "cycle": {
      "number": 1,
      "current": true,
      "currentCycle": 1,
      "totalCycles": 1,
      "startedAt": "2026-09-28T09:12:50.000Z",
      "endsAt": "2026-11-27T09:20:11.000Z",
      "closedAt": "string"
    },
    "brokers": [
      {
        "brokerId": 128,
        "brokerSlug": "broker-name",
        "brokerName": "Broker Name",
        "logoUrl": "https://domain.com/logos/broker-name.png",
        "type": "public",
        "category": "people-search",
        "cycle": 1,
        "scanStatus": "PROFILE_FOUND",
        "removalStatus": "REQUEST_SUBMITTED",
        "statusUpdatedAt": "2026-09-28T10:02:11.000Z",
        "action": null,
        "timeline": [
          {
            "step": "REQUEST_SUBMITTED",
            "label": "Submitted",
            "state": "current",
            "at": "2026-09-28T10:02:11.000Z"
          }
        ],
        "missingFields": [],
        "evidence": {
          "scanScreenshotKey": "evidence/.../1759053731000.png",
          "removalScreenshotKey": "evidence/.../1759054011000.png"
        },
        "matchedRecord": {},
        "matchConfidence": "matched",
        "matchListingCount": 1,
        "removedAt": "string",
        "enabled": true
      }
    ],
    "summary": {
      "total": 1,
      "inProgress": 1,
      "actionRequired": 0,
      "completed": 0,
      "notFound": 0,
      "found": 1
    }
  }
}

Status Codes

Status	Meaning
`200`	Status returned.
`400`	10216: cycle is not a whole number of 1 or more.
`401`	10103: the calling account is not an active Data Broker Opt-Out partner.
`404`	10200: no user with this profileId for this partner. 10217: the user has no such cycle yet.
`500`	Internal Server Error.

Error codes

Returned in header.response_code when the request fails.

Code	Message
`10103`	The calling account is not an active Data Broker Opt-Out partner.
`10200`	No user with this profileId for this partner.
`10216`	`cycle` is not a whole number of 1 or more.
`10217`	The user has no such cycle yet.

See Errors for the response envelope and the full list of codes.

Overview

User Management

Dark Web Monitoring

Data Broker Opt-Out Service

Authentication

Path Parameters

Query Parameters

Sample Request

Response

Sample Response

Status Codes

Error codes

​Authentication

​Path Parameters

​Query Parameters

​Sample Request

​Response

​Sample Response

​Status Codes

​Error codes

Authentication

Path Parameters

Query Parameters

Sample Request

Response

Sample Response

Status Codes

Error codes