×

Login to Safe Shepherd

Recover your password

Safe Shepherd API Documentation

Set user identification

Sets secure photo identification for a user.

POST /api/:integration_name/:api_key/v2/users/:id/set_identification(.: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*
identification
Base64 Data-URI encoded data of png image of redacted picture - Data_uri*

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 struct

Notes

Identification must be properly encoded and should be a valid png. Existing identification on-file will be deleted upon success.