×

Login to Safe Shepherd

Recover your password

Safe Shepherd API Documentation

Alert

An alert is an important event for a user, such as a removal being processed from a site. Additionally, alerts will be created when we find a web link with personal exposure for a user or when we verify a record has been removed for a foreign database.

Fields

text
Text of the alert with details on the event, accessible by end-user. - String
html
HTML of the alert with details on the event, similar to the `text` field. - String
url
URL (if available) where underlying record or link is publically listed. - String
guide
Description of the website hosting the information (e.g. "what is Spokeo.com") - String
opt_out_procedure
Array of strings describing steps a user could take to manually remove a web link. Each is formatted in markdown. - Array
source_type
Is the reason we created this alert due to a `link` or a `record`? - String
source
Underlying object (see `source_type`) which caused this alert (a `record` or `link` struct) - Object

Example

{
  "alert": {
    "text": "Safe Shepherd API has submitted an Automated opt-out to Intelius to remove a record which we've identified as having your information.",
    "html": "Safe Shepherd API has submitted an Automated opt-out to\n<b>Intelius</b>\nto remove a record which we've identified as having\n<b>Tommy Lee Jones</b>.\n\n",
    "guide": "Intelius is one of the largest people search sites in the industry. It exposes your home addresses, phone numbers, age, date of birth, relatives, income, aliases, and court records, past and present.",
    "opt_out_procedure": [
      "Visit Intelius' [Opt Out page](https://www.intelius.com/optout.php).",
      "Attach a state-issued ID to verify your identity (in our opinion, an unnecessary burden intended to discourage you).",
      "Provide your email address.",
      "In the Additional Information section, indicate that you would also like to be removed from all other databases they own, including Zabasearch.",
      "Click submit.",
      "Your records should be removed in 7-14 days."
    ],
    "source_type": "record",
    "source": {
      "record": {
        "id": 318,
        "name": "Tommy Lee Jones",
        "site": "Intelius",
        "status": "discovered",
        "age": null,
        "href": "http://www.intelius.com/Find-Phone-Address/Clinton-KY/Tommy-Jones.html",
        "relations": [
          "Maria Jones",
          "Jesse Jones"
        ],
        "aliases": [
          "Thom"
        ],
        "locations": [
          "Glendale, CA",
          "Pasadena, CA",
          "North Hollywood, CA"
        ],
        "reference_id": "000560228488"
      }
    }
  }
}