×

Login to Safe Shepherd

Recover your password

Safe Shepherd API Documentation

Scan user

Scan the web for additional records and links about a user.

POST /api/:integration_name/:api_key/v2/users/:id/scan(.:format)

Parameters

api_key
API access key - String*
api_secret
API secret key - String*
id
User id returned during user creation - Integer*
secret
Secret associated with user account during creation - Integer*
async
If 'true' or '1', returns immediately with no additinoal records or links; scan will be initiated asynchronously. See `is_scanning` column and `Get user records` endpoint. - Boolean

Returns

HTTP 401 - Unauthorized

If api_key missing or invalid, or user-secret failed authorization.

HTTP 400 - Bad Request

If fields missing or invalid

HTTP 200 - Success

Returns JSON/XML-encoded user struct

Notes

This may be called periodically to keep fresh information for an API user, beyond Safe Shepherd's normal rescan schedule.