API documentation

Portfolio Monitoring asset

A value on your Portfolio Monitoring watchlist.

Fields

idstring
Record id.
typestring
Asset type: `email`, `phone`, `username`, `tc`, `taxid`, `domain`.
valuestring
The watched value.
labelstring | null
Display label (optional).
statusstring
Monitoring status: `monitored`, `leaked`, `clean`, `checking`.
groupIdstring | null
Group it belongs to (if any).
bankCodestring | null
Bank code for card assets (if any).
pausedboolean
Whether watching is paused.
verifiedboolean
Whether ownership is verified.
verifiableboolean
Whether this type can be verified.
findingsCountnumber
Number of findings for this asset.
lastCheckedAtstring
Last check time.
addedAtstring
When it was added to the watchlist.

JSON schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://darkradar.com/docs/schemas/watch-asset.schema.json",
  "title": "Portfolio Monitoring asset",
  "description": "A value on your Portfolio Monitoring watchlist.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Record id."
    },
    "type": {
      "type": "string",
      "description": "Asset type: `email`, `phone`, `username`, `tc`, `taxid`, `domain`."
    },
    "value": {
      "type": "string",
      "description": "The watched value."
    },
    "label": {
      "type": [
        "string",
        "null"
      ],
      "description": "Display label (optional)."
    },
    "status": {
      "type": "string",
      "description": "Monitoring status: `monitored`, `leaked`, `clean`, `checking`."
    },
    "groupId": {
      "type": [
        "string",
        "null"
      ],
      "description": "Group it belongs to (if any)."
    },
    "bankCode": {
      "type": [
        "string",
        "null"
      ],
      "description": "Bank code for card assets (if any)."
    },
    "paused": {
      "type": "boolean",
      "description": "Whether watching is paused."
    },
    "verified": {
      "type": "boolean",
      "description": "Whether ownership is verified."
    },
    "verifiable": {
      "type": "boolean",
      "description": "Whether this type can be verified."
    },
    "findingsCount": {
      "type": "number",
      "description": "Number of findings for this asset."
    },
    "lastCheckedAt": {
      "type": "string",
      "description": "Last check time."
    },
    "addedAt": {
      "type": "string",
      "description": "When it was added to the watchlist."
    }
  }
}

Endpoints that return this schema

Was this page helpful?