Member Fields

Field Name	Data Type	Description
guid	String	The unique identifier for the member. Defined by MX.
id	String	The unique partner-defined identifier for the member. The id cannot begin with MBR- as this is reserved for the system. It must be unique for all members belonging to all users within the client. Can include numbers, letters, dash, and underscore. Max Length is 1024.
institution_id	String	A client-specific ID that can be used to identify an alternate institution in a create member request. The institution_id field is rarely used. By default, a member is automatically connected to the default institution that MX has set up for each client. If there is a need to connect the user to multiple partner-managed institutions, then MX will set up an institution_id field that can be used in the create member request to specify a different institution.
is_disabled	Boolean	This indicates whether a member is disabled. Defaults to false. If is_disabled is set to true, MX will not send On Demand aggregation requests for that member. If a user is disabled then the members belonging to that user are automatically disabled as well. If the user is re-enabled (setting is_disabled back to false) then all members belonging to that user will also be re-enabled.
login	String	Login credential, used in conjunction with password, that authenticates the user in a partner's system. Used as alternative to userkey.
metadata	String	Additional information a partner can store on the member.
name	String	Name of the given member. If omitted in a member create request, the institution name within the MX Platform will be used. Max Length is 100. The name field is rarely used in the create member request. The preferred option is to omit the field and use the default name, which is the name of the institution set up by MX. Only in rare circumstances would the name field be supplied in a member create request, and it should not be used unless you have discussed it with a MX Integration Engineer.
password	String	Password credential, used in conjunction with login, that authenticates the user in a partner's system. Used as alternative to userkey.
user_guid	String	The unique identifier for the user this member belongs to. Defined by MX.
user_id	String	The unique partner-defined identifier of the user this member belongs to.
userkey	String	This unique value is sent to the partner's MDX On Demand service to authenticate an aggregation request for a specific user. It is the preferred credential over login/password.