Skip to main content

Nexus API

Users Overview

User Fields

Field NameData TypeDescription
accepted_terms_and_conditions_atstringThe 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).
birthdaystringBirthdate of user, represented in ISO 8601 format (e.g. 2011-03-28).
credit_scoreintegerCredit score of the user.
emailstringEmail address of the user.
email_is_verifiedbooleanIf the email is verified, this field will be true. Otherwise, this field will be false.
external_guidstringPartner created identifier for the user.
failed_token_login_attempts_countintegerNumber of failed login attempts for the user. Defaults to 0.
first_namestringFirst name of the user.
genderintegerGender of the user. Returns 0 for male and 1 for female.
guidstringUnique identifier for the user. Defined by MX.
has_accepted_terms_and_conditionsbooleanIf 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_conditionsbooleanIf 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_disabledbooleanIf the user is disabled, this field will be true. Otherwise, this field will be false.
is_restrictedbooleanIf the user is restricted, this field will be true. Otherwise, this field will be false.
last_namestringLast name of the user.
logged_in_atstringDate and time the user last logged in, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).
metadatastringAdditional information a partner can store on the user.
phonestringPhone number of the user.
phone_is_verifiedbooleanVerifies the phone for the user. Returns true or false; defaults to false.
postal_codestringUS ZIP codes and Canadian postal codes are supported. Valid formats are: 12345, 12345-6789, A1B2C3, or A1B 2C3.
revisionintegerThe revision number of this user record.
On this page