×

Login to Safe Shepherd

Recover your password

Safe Shepherd API Documentation

User

Represents a user registered on the Safe Shepherd API. There should be a one-to-one relationship of users to end-users.

Fields

id
Id associated with user. Must be stored when user is created. - Integer
secret
Secret token associated with user. Must be stored when user is created. - Text
birth_date
Birth date of user, if on file. - Datetime
first_name
First name of user - String
middle_name
Middle name of user - String
last_name
Last name of user - String
aliases
List of aliases for user (e.g. Iggy) - List
emails
List of e-mails on file. E-mails are used for identity matching. - List
phone_numbers
List of phone numbers for user - List
records
List of people-search records found for user. See Record struct. - List
links
List of links Safe Shepherd has discovered based on user information. See Link struct. - List
service_history
List of detailed service history for a user (when they were or were not an active account). This will be a list of structs containing either `activated_service_on` or `deactivated_service_on` with a datetime for that event. - List
is_scanning
Is an asynchronous scan for more information active for this user? When doing asynchronous user creation, you can use this flag to know when a scan is complete. - Boolean
identification_onfile
Has this user uploaded State Identification? - Boolean

Example

{
  "user": {
    "id": 12,
    "secret": "TOP SECRET",
    "birth_date": null,
    "first_name": "Tommy",
    "middle_name": "Lee",
    "last_name": "Jones",
    "aliases": [
      {
        "id": 123,
        "first_name": "Tom",
        "last_name": "Yorke"
      }
    ],
    "emails": [
      {
        "id": 123,
        "address": "tom@example.com"
      }
    ],
    "phone_numbers": [
      {
        "id": 123,
        "number": "3128881212"
      },
      {
        "id": 124,
        "number": "2153331212"
      }
    ],
    "addresses": [
      {
        "id": 123,
        "address1": "123 N Jones Street",
        "address2": null,
        "city": "Pasadena",
        "state": "CA",
        "zip": "91101"
      }
    ],
    "records": [
      {
        "id": 318,
        "name": "Tommy Lee Jones",
        "site": "Intelius",
        "status": "discovered",
        "age": null,
        "href": null,
        "relations": [
          "Maria Jones",
          "Jesse Jones"
        ],
        "aliases": [
          "Thom"
        ],
        "locations": [
          "Glendale, CA",
          "Pasadena, CA",
          "North Hollywood, CA"
        ],
        "reference_id": "000560228488",
        "user_fields_required_for_removal": [
          "first_name",
          "address1"
        ]
      }
    ],
    "links": [
      {
        "url": "http://github.com/hayesgm",
        "title": "Github | hayesgm",
        "contains": [
          "email",
          "address"
        ]
      }
    ],
    "service_history": [
      {
        "activated_service_on": "2012/05/27 00:46:39 +0000"
      },
      {
        "deactivated_service_on": "2012/05/30 00:46:39 +0000"
      },
      {
        "activated_service_on": "2012/06/01 00:46:39 +0000"
      }
    ],
    "is_scanning": false,
    "identification_on_file": true
  }
}