×

Login to Safe Shepherd

Recover your password

Safe Shepherd API Documentation

Send new alerts via e-mail

Ping a user about new events, such as new records found or removals processed.

POST /api/:integration_name/:api_key/v2/users/:user_id/alerts/email(.: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*
email
E-mail address to send user alert to (required if user does not have an e-mail address set) - String
limit
Limit how many alerts are sent in e-mail - 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": [
    "Safe Shepherd API has submitted an Automated opt-out to Intelius to remove a record which we've identified as having your information.",
    "Safe Shepherd API has submitted an Automated opt-out to Spokeo to remove a record which we've identified as having your information.",
    "Safe Shepherd API has verified that your record on Spokeo, which we identified as having your information has been removed."
  ]
}

Notes

We will sent out an e-mail alerting user of: new records discovered, records recently processed for removal or verified as removed from the web, and new non-removable records discovered. We only alert the user of new items since the last ping was sent. If there are no new items, an alert is not sent.