Users Overview

Users represent an end user using the Platform API through your web or mobile app.

Users are created by MX clients and belong to a specific client on the platform.

User Fields

Field	Data Type	Description
accepted_terms_and_conditions_at	String	The timestamp when the user accepted the terms and conditions. Formatted as ISO 8601 datetime string.
born_on	String	Birthdate of user, represented in ISO 8601 format (e.g. 2011-03-28)
credit_score	Integer	The user's credit score as a numerical value.
email	String	Email address of the user.
email_is_verified	Boolean	If the email is verified, this field will be true. Otherwise, this field will be false.
failed_login_attempts_count	Integer	Number of failed login attempts for the user. Defaults to 0.
first_name	String	The user's first name.
gender	String	Gender of the user. Returns 0 for male and 1 for female.
guid	String	The unique identifier for the user defined by MX.
has_accepted_terms_and_conditions	Boolean	If updated terms and conditions are available for the end user, this field will be true. This field will return to false when the user has accepted the updated terms.
is_disabled	Boolean	If the user is disabled, this field will be true. Otherwise, this field will be false.
is_restricted	Boolean	If the user is restricted, this field will be true. Otherwise, this field will be false.
last_name	String	The user's last name.
logged_in_at	String	Date and time the user last logged in, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).
metadata	String	Additional information you can store about this user. MX recommends using JSON-structured data.
phone	String	The user's phone number.
phone_is_verified	Boolean	Verifies the phone for the user. Returns true or false; defaults to false.
postal_code	String	US ZIP codes and Canadian postal codes are supported. Valid formats are: 12345, 12345-6789, A1B2C3, or A1B 2C3.