In documentation code examples, replace <API_KEY_VALUE> with the session token.
Response
200 - application/vnd.mx.api.v1+json
OK
user
object
Hide child attributes
user.accepted_terms_and_conditions_at
string<date-time>
The most recent date and time the end user accepted either initial or updated terms and conditions. Represented in ISO 8601 format with a timestamp (e.g., 2015-04-13T12:01:23-00:00).
Example:
"2020-08-31T16:12:36+00:00"
user.birthday
string<date> | null
Birthdate of user, represented in ISO 8601 format (e.g. 2011-03-28).
Example:
"2011-03-28"
user.credit_score
integer
Credit score of the user.
Example:
0
user.email
string
Email address of the user.
Example:
"fake.email@mxexample.com"
user.email_is_verified
boolean
If the email is verified, this field will be true. Otherwise, this field will be false.
Example:
false
user.external_guid
string
Partner created identifier for the user.
Example:
"U-201709221210"
user.failed_token_login_attempts_count
integer
Number of failed login attempts for the user. Defaults to 0.
Example:
0
user.first_name
string
First name of the user.
Example:
"John"
user.gender
integer | null
Gender of the user. Returns 0 for male and 1 for female.
Example:
0
user.guid
string
Unique identifier for the user. Defined by MX.
Example:
"USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
user.has_accepted_terms_and_conditions
boolean
If the end user has accepted the initial terms and conditions, this field will be true. Otherwise, this field will be false. This field does not update.
Example:
true
user.has_updated_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.
Example:
false
user.is_disabled
boolean
If the user is disabled, this field will be true. Otherwise, this field will be false.
Example:
false
user.is_restricted
boolean
If the user is restricted, this field will be true. Otherwise, this field will be false.
Example:
false
user.last_name
string
Last name of the user.
Example:
"Doe"
user.logged_in_at
string<date-time>
Date and time the user last logged in, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).
Example:
"2022-07-08T16:28:13+00:00"
user.metadata
string | null
Additional information a partner can store on the user.
Example:
null
user.phone
string | null
Phone number of the user.
Example:
null
user.phone_is_verified
boolean
Verifies the phone for the user. Returns true or false; defaults to false.
Example:
false
user.postal_code
string
US ZIP codes and Canadian postal codes are supported. Valid formats are 12345, 12345-6789, A1B2C3, or A1B 2C3.