The user object is based on the portable contacts specification. It is extended with some custom fields.
userId is an integer and represents the unique user ID, while
id is a legacy uuid and should be ignored in new integrations. The
uuid is also a user identifier, which is is globally unique and should therefore be the preferred identifier for a user. The
phoneNumber fields will always contain the primary used for both if available. The corresponding *Verified fields are the date of the last time those were verified.
When requesting a user that is not connected to the authorized client, only public profile data will be available:
Unique user ID. Custom extension.
Unique user UUID. Custom extension. Should be preferred as the user identifier.
A JSON string. See the name type for details
Name suitable for displaying to end-users.
The date this user was first added. Can return false if the user account was deleted.
The most recent date the details of this user were updated
Date when the email was last verified.
list of Email addresses
All user's registered email addresses.
Primary phone number
Date when the phone number was last verified.
list of Phone numbers
All user's registered phone numbers.
Date when user last verified data (email, phone number). Returns false if user wasn't verified.
URL to a photo of the user (GIF/JPG/PNG)
One of undisclosed, female, male, other, withheld. Default is undisclosed. Portable contacts
Date of birth in YYYY-MM-DD format. Year will be 0000 if not provided. Defaults to 0000-00-00. Portable contacts
The user's preferred locale. Locales follow ISO Language and country codes respectively, joined by an underscore.
The user's timezone, given as offset from UTC.
Returns false if the user has not been logged in before.
The last time the user authenticated with their password. Returns false if the user has not been authenticated before.
If user has no addresses returns empty array.
list of Third-party accounts
Third-party accounts and other client services
List of SPiD merchants the user is connected to
list of Addresses
If user has no current location returns empty array.
The check mark ✓ indicates that the field always contains a valid non-empty value.
Do you have questions, or just want to contribute some newly gained insight? Want to share an example? Please leave a comment. SPiD reads and responds to every question. Additionally, your experience can help others using SPiD, and it can help us continuously improve our documentation.