×

Login to Safe Shepherd

Recover your password

Safe Shepherd API Documentation

Get user alerts

Get alerts for user about new events, such as new records found or removals processed.

GET /api/:integration_name/:api_key/v2/users/:user_id/alerts(.:format)

Parameters

api_key
API access key - String*
api_secret
API secret key - String*
user_id
User ID returned during user creation - Integer*
secret
Secret associated with user account during creation - Integer*

Returns

HTTP 401 - Unauthorized

If api_key missing or invalid, or User / User-secret mismatch

HTTP 400 - Bad Request

If fields missing or invalid

HTTP 200 - Success

Alert is successfully sent, or ignored for no records

Returns JSON/XML-encoded <alert> struct

View Example
{
  "alerts": [
    {
      "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",
      "url": "http://www.intelius.com/Find-Phone-Address/Clinton-KY/Tommy-Jones.html",
      "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"
        }
      }
    },
    {
      "text": "Safe Shepherd API has submitted an Automated opt-out to Spokeo 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>Spokeo</b>\nto remove a record which we've identified as having\n<b>Tommy Lee Jones</b>.\n\n",
      "url": "http://www.spokeo.com/Tommy+Jones/California",
      "guide": "Spokeo is one of the larger people search sites. The expose primarily public records and publicly available information.",
      "opt_out_procedure": [
        "Locate the individual listing to remove (for name listings, please select the state, city, then exact profile match).",
        "Copy the URL (the URL can be found on the top of your browser and should look something like http://www.spokeo.com/search?q=Smith%20Sample#Sample:1219812367).",
        "Go to Spokeo's [opt out page](http://www.spokeo.com/optout).",
        "Paste the URL.",
        "! 'Provide your email address (this acts as a verification process for the confirmation to be sent to your Inbox) and solve the captcha.'",
        "Check your Inbox for the confirmation email, and click on the link on the bottom to complete the removal process.",
        "The directory listing will become flagged and will be removed within 1 business day."
      ],
      "source_type": "record",
      "source": {
        "record": {
          "id": 319,
          "name": "Tommy Jones",
          "site": "Spokeo",
          "status": "pending removal",
          "age": 45,
          "href": "http://www.spokeo.com/Tommy+Jones/California",
          "relations": [
            "Jesse Jones"
          ],
          "aliases": [

          ],
          "locations": [
            "Glendale, CA",
            "North Hollywood, CA"
          ],
          "reference_id": "45422fbc"
        }
      }
    },
    {
      "text": "Safe Shepherd API has verified that your record on Spokeo, which we identified as having your information has been removed.",
      "html": "Safe Shepherd API has verified that your record on\n<b>Spokeo</b>,\nwhich we identified as having\n<b>Tommy Lee Jones</b>\n\nhas been removed.\n",
      "url": "http://www.spokeo.com/Tommy+Jones/California",
      "guide": "Spokeo is one of the larger people search sites. The expose primarily public records and publicly available information.",
      "opt_out_procedure": [
        "Locate the individual listing to remove (for name listings, please select the state, city, then exact profile match).",
        "Copy the URL (the URL can be found on the top of your browser and should look something like http://www.spokeo.com/search?q=Smith%20Sample#Sample:1219812367).",
        "Go to Spokeo's [opt out page](http://www.spokeo.com/optout).",
        "Paste the URL.",
        "! 'Provide your email address (this acts as a verification process for the confirmation to be sent to your Inbox) and solve the captcha.'",
        "Check your Inbox for the confirmation email, and click on the link on the bottom to complete the removal process.",
        "The directory listing will become flagged and will be removed within 1 business day."
      ],
      "source_type": "record",
      "source": {
        "record": {
          "id": 319,
          "name": "Tommy Jones",
          "site": "Spokeo",
          "status": "removed",
          "age": 45,
          "href": "http://www.spokeo.com/Tommy+Jones/California",
          "relations": [
            "Jesse Jones"
          ],
          "aliases": [

          ],
          "locations": [
            "Glendale, CA",
            "North Hollywood, CA"
          ],
          "reference_id": "45422fbc"
        }
      }
    },
    {
      "text": "Safe Shepherd API has found tom@example.com exposed on Scribd.",
      "html": "Safe Shepherd API has found <b>tom@example.com</b> exposed on <b>Scribd</b>.",
      "url": "http://www.scribd.com/doc/31010001/HP-Gloe-API-Documentation-an-HP-Labs-experiment",
      "guide": "Scribd is essentially a document repository where users upload content that can be viewed (and searched) by the public. The boast everything from up-and-coming books by new authors, to court filings that have been making the news, to academic papers from scholars around the world.",
      "opt_out_procedure": "Your information probably ended up on Scribd in one of two ways: either you uploaded it yourself in a document, or someone else uploaded a document that remveals some or all of your personal information. In the first case, simply log into your account and remove the revealing content. In the second, your best hope is to contact the user who published the offending document and ask nicely that your information be removed. Other users have no obligation to comply with your request, but we''ve found asking nicely to be a surprisingly effective strategy.",
      "source_type": "link",
      "source": {
        "link": {
          "url": "http://github.com/hayesgm",
          "title": "Github | Hayesgm",
          "contains": [
            "email",
            "address",
            "phone"
          ]
        }
      }
    }
  ]
}

Notes

Alerts for a user will be returns with text and haml variants of the alert.