Nexus API
Users Overview
User Fields
| Field Name | Data Type | Description |
|---|---|---|
accepted_terms_and_conditions_at | string | 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). |
birthday | string | Birthdate of user, represented in ISO 8601 format (e.g. 2011-03-28). |
credit_score | integer | Credit score of the user. |
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. |
external_guid | string | Partner created identifier for the user. |
failed_token_login_attempts_count | integer | Number of failed login attempts for the user. Defaults to 0. |
first_name | string | First name of the user. |
gender | integer | Gender of the user. Returns 0 for male and 1 for female. |
guid | string | Unique identifier for the user. Defined by MX. |
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. |
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. |
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 | Last name of the user. |
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 a partner can store on the user. |
phone | string | Phone number of the user. |
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. |
revision | integer | The revision number of this user record. |