Schema

The fields on this page can appear within your data warehouse.

Accounts

An account represents a financial account, for example, a user's checking or savings account. A member may have more than one account associated with it. For instance, a user may have both a checking and savings account associated with one Chase login and would therefore have two accounts associated with that member.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the account. Defined by MX.
id	String	255	The unique partner-defined identifier for the account.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
member_guid	String	40	(Foreign Key to members.guid) The unique identifier for the member that this account belongs to.
member_id	String	255	The unique partner-defined identifier for the member.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user that this account belongs to.
user_id	String	255	The partner-defined identifier for the user.
account_number	String	255	The account number associated with the account. This will typically be a masked or partial account number. Note: This field will be null for this iteration.
account_subtype	String	255	The subtype of the account (e.g., CHECKING, SAVINGS).
account_type	String	255	The type of the account (e.g., CHECKING, SAVINGS).
apr	Double	10,6	The annual percentage rate for the account.
apy	Double	10,6	The annual percentage yield for the account.
available_balance	Double	14,2	The available balance of the account.
available_credit	Double	14,2	The available credit on the account.
balance	Double	14,2	The current balance of the account.
cash_balance	Double	14,2	The cash balance of the account.
created_at	Timestamp	29	The date and time the account was created.
interest_rate	Double	10,6	The interest rate for the account.
loan_amount	Double	14,2	The original loan amount.
metadata	String	4096	Additional information a partner can store on the account.
name	String	80	The name of the account.
payoff_balance	Double	14,2	The payoff balance of the account.
revision	Long	4	The revision number of the table.
statement_balance	Double	14,2	The statement balance of the account.
total_account_value	Double	14,2	The total value of the account.
updated_at	Timestamp	29	The date and time the account was last updated.

Account Details

This table contains additional, more detailed information about an account.

Field	Type	Length	Description
guid	String	40	(Primary Key, Foreign Key to accounts.guid) The unique identifier for the account detail record, which is the same as the account GUID.
id	String	255	The unique partner-defined identifier for the account.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user that this account belongs to.
user_id	String	255	The partner-defined identifier for the user.
account_ownership	String	255	The ownership status of the account (e.g., INDIVIDUAL, JOINT).
annuity_policy_to_date	Timestamp	29	The policy to-date for an annuity account.
annuity_provider	String	255	The provider for an annuity account.
annuity_term_year	Long	4	The term year for an annuity account.
cash_advance_apr	Double	10,6	The cash advance APR for a credit account.
cash_surrender_value	Double	14,2	The cash surrender value of a life insurance policy.
credit_limit	Double	10,2	The credit limit for a credit account.
currency_code	String	255	The currency in which the holding is denominated.
day_payment_is_due	Long	2	The day of the month the payment is due.
death_benefit	Long	14	The death benefit of a life insurance policy.
federal_insurance_status	String	255	The federal insurance status of the account.
has_monthly_transfer_limit	Boolean		Indicates if the account has a monthly transfer limit.
holdings_value	Double	14,2	The total value of holdings in an investment account.
imported_at	Timestamp	29	The date and time the account was imported.
insured_name	String	255	The name of the insured person on a policy.
is_closed	Boolean		Indicates if the account is closed.
is_hidden	Boolean		Indicates if the account is hidden from the user's view.
is_manual	Boolean		Indicates if the account was created manually.
last_payment	Double	10,2	The amount of the last payment made.
last_payment_at	Timestamp	29	The date and time of the last payment.
margin_balance	Double	14,2	The margin balance of an investment account.
matures_at	Timestamp	29	The date the account matures.
member_is_managed_by_user	Boolean		Indicates if the member is managed by the user or the partner.
minimum_balance	Double	14,2	The minimum balance required for the account.
minimum_payment	Double	10,2	The minimum payment due.
monthly_transfer_count	Long	4	The number of transfers made in the current month.
nickname	String	255	The user-defined nickname for the account.
original_balance	Double	14,2	The original balance of the account.
pay_out_amount	Double	14,2	The pay out amount for the account.
payment_due_at	Timestamp	29	The date and time the next payment is due.
pending_balance	Double	14,2	The pending balance of the account.
premium_amount	Double	10,2	The premium amount for an insurance policy.
property_type	String	255	The type of property associated with a loan account.
revision	Long	4	The revision number of the table.
routing_number	String	225	The routing number for the account.
started_at	Timestamp	29	The date and time the account was opened.
today_ugl_amount	Double	14,2	Today's unrealized gains/losses amount.
today_ugl_percentage	Double	14,2	Today's unrealized gains/losses percentage.
total_account_value_ugl	Double	14,2	The total unrealized gains/losses for the account.
updated_at	Timestamp	29	The date and time the account details were last updated.

Analytics Events

Analytics events occur within a Personal Finance Management widget (desktop or mobile) or a Mobile Banking app view.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the analytics event.
app_guid	String	40	The GUID of the application.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
device_guid	String	40	(Foreign Key to devices.guid) The GUID of the device.
device_id	String	255	The unique identifier for the device associated with the analytics event; resets on every login. Defined by MX.
device_uid	String	255	The unique identifier for the device associated with the analytics event; remains constant across logins. Defined by MX.
session_id	String	255	The ID of the session.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user.
user_id	String	255	The partner-defined identifier for the user.
action	String	255	The action that triggered the event.
app_version	String	255	The version of the application.
category	String	255	The category of the event.
created_at	Timestamp	29	The date and time the event was created.
data_source	String	255	The source of the data.
is_mobile_webview	Boolean		Indicates if the event was from a mobile webview.
mdx_session_id	String	255	The MDX session ID.
name	String	80	The name of the event.
screen_resolution	String	255	The screen resolution.
updated_at	Timestamp	29	The date and time the event was last updated.
user_agent	String	255	The user agent string.
user_ip_address	String	255	The unique IP address for the user associated with the analytics event.
value	String	1024	The value associated with the event.

Analytics Pageviews

Page view events are specific to web-based PFM, online banking, etc.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the pageview.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
session_id	String	255	The ID of the session.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user.
user_id	String	255	The partner-defined identifier for the user.
app_version	String	255	The version of the application.
created_at	Timestamp	29	The date and time the pageview was created.
data_source	String	255	The source of the data.
host	String	255	The host of the page.
is_mobile_webview	Boolean		Indicates if the pageview was from a mobile webview.
name	String	80	The name of the page.
path	String	255	The path of the page.
screen_resolution	String	255	The screen resolution.
updated_at	Timestamp	29	The date and time the pageview was last updated.
user_agent	String	255	The user agent string.
user_ip_address	String	255	The unique IP address for the user associated with the analytics event.

Analytics Screenviews

Screen view events are specific to mobile-based PFM, mobile banking, etc.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the screenview.
app_guid	String	40	The GUID of the application.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
device_guid	String	40	(Foreign Key to devices.guid) The GUID of the device.
device_id	String	255	The unique identifier for the device associated with the analytics event; resets on every login. Defined by MX.
device_uid	String	255	The unique identifier for the device associated with the analytics event; remains constant across logins. Defined by MX.
session_id	String	255	The ID of the session.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user.
user_id	String	255	The partner-defined identifier for the user.
app_version	String	255	The version of the application.
created_at	Timestamp	29	The date and time the screenview was created.
data_source	String	255	The source of the data.
mdx_session_id	String	255	The MDX session ID.
name	String	80	The name of the screen.
screen_resolution	String	255	The screen resolution.
updated_at	Timestamp	29	The date and time the screenview was last updated.
user_agent	String	255	The user agent string.
user_ip_address	String	255	The unique IP address for the user associated with the analytics event.

Analytics Timed Events

Timed events are used to track how long a user spends on a certain task.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the timed event.
app_guid	String	40	The GUID of the application.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
device_guid	String	40	(Foreign Key to devices.guid) The GUID of the device.
device_id	String	255	The unique identifier for the device associated with the analytics event; resets on every login. Defined by MX.
device_uid	String	255	The unique identifier for the device associated with the analytics event; remains constant across logins. Defined by MX.
session_id	String	255	The ID of the session.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user.
user_id	String	255	The partner-defined identifier for the user.
app_version	String	255	The version of the application.
category	String	255	The category of the event.
created_at	Timestamp	29	The date and time the event was created.
data_source	String	255	The source of the data.
interval	Long	12	The duration of the analytics timed event from start to finish, given in milliseconds.
mdx_session_id	String	255	The MDX session ID.
name	String	80	The name of the event.
screen_resolution	String	255	The screen resolution.
updated_at	Timestamp	29	The date and time the event was last updated.
user_agent	String	255	The user agent string.
user_ip_address	String	255	The unique IP address for the user associated with the analytics event.
version	String	255	The version of the event.

Budgets

The budgets object is used to create and manage budgets.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the budget.
category_guid	String	40	(Foreign Key to categories.guid) The unique identifier for the category associated with the budget.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
parent_guid	String	40	(Foreign Key to budgets.guid) The GUID of the parent budget.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user.
user_id	String	255	The partner-defined identifier for the user.
amount	Double	14,2	The budgeted amount.
created_at	Timestamp	29	The date and time the budget was created.
is_exceeded	Boolean		Indicates if the budget has been exceeded.
is_off_track	Boolean		Indicates if the budget is off track.
metadata	String	4096	Additional information a partner can store on the budget.
name	String	80	The name of the budget.
projected_spending	Double	10,2	The projected spending for the budget period.
revision	Long	4	The revision number of the budget.
transaction_total	Double	10,2	The total amount of transactions for the budget.
updated_at	Timestamp	29	The date and time the budget was last updated.

Categories

The categories object is used to categorize transactions.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the category. Defined by MX.
parent_guid	String	40	(Foreign Key to categories.guid) The unique identifier for the parent category.
top_level_category_guid	String	40	(Foreign Key to categories.guid) The GUID of the top-level parent category.
created_at	Timestamp	29	The date and time the category was created.
is_default	Boolean		Indicates if this is a default category provided by MX.
is_income	Boolean		This indicates whether the transaction represents income.
metadata	String	4096	Additional information a partner can store on the category.
name	String	80	The category of the transaction.
revision	Long	4	The revision number of the category record.
top_level_category	String	80	The parent category assigned to this transaction's category.
updated_at	Timestamp	29	The date and time the category was last updated.

Classifications

The classifications object represents transaction classifications.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the classification.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
parent_class	String	255	The parent class of the classification.
updated_at	Timestamp	29	The date and time the classification was last updated.

Clients

The clients object represents an individual client.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the client.
id	String	255	The unique partner-defined identifier for the client.
created_at	Timestamp	29	The date and time the feedback was created.
name	String	80	The name of the client.
online_banking_users_count	Long	10	The estimated number of online banking users associated with this client.
updated_at	Timestamp	29	The date and time the client was last updated.

Devices

The devices object stores information about user devices.

Field	Type	Length	Description
guid	String	50	(Primary Key) The unique identifier for the device.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user.
user_id	String	255	The partner-defined identifier for the user.
make	String	255	The make of the device (e.g., Apple).
model	String	255	The model of the device (e.g., iPhone 13).
os_name	String	255	The name of the operating system (e.g., iOS).
os_version	String	255	The version of the operating system.
updated_at	Timestamp	29	The date and time the device was last updated.

Discovered Accounts

The discovered_accounts object represents accounts discovered during an aggregation that have not yet been added by the user.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the discovered account.
account_guid	String	40	(Foreign Key to accounts.guid) The GUID of the associated account, if it has been created.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
organization_guid	String	40	The unique identifier for the organization.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user.
user_id	String	255	The partner-defined identifier for the user.
created_at	Timestamp	29	The date and time the discovered account was created.
deleted_at	Timestamp	29	The date and time the discovered account was deleted.
discovered_account_subtype	String	255	The subtype of the discovered account.
discovered_account_type	String	255	The type of the discovered account.
has_been_aggregated	Boolean		Indicates if the account has been aggregated.
is_deleted	Boolean		Indicates if the account has been deleted.
most_recent_transaction_amount	Double	10,2	The amount of the most recent transaction.
most_recent_transaction_date	Timestamp	29	The date of the most recent transaction.
most_recent_transaction_guid	String	40	(Foreign Key to transactions.guid) The GUID of the most recent transaction.
name	String	80	The name of the discovered account.
organization_name	String	255	The name of the organization.
potentially_carries_a_balance	Boolean		Indicates if the account potentially carries a balance.
updated_at	Timestamp	29	The date and time the discovered account was last updated.

Discovered Transactions

The discovered_transactions object represents transactions from discovered accounts.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the discovered transaction.
id	String	255	The unique partner-defined identifier for the transaction.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
discovered_account_guid	String	40	(Foreign Key to discovered_accounts.guid) The GUID of the discovered account.
organization_guid	String	40	The GUID of the organization.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user.
user_id	String	255	The partner-defined identifier for the user.
amount	Double	10,2	The amount of the transaction.
created_at	Timestamp	29	The date and time the transaction was discovered.
posted_at	Timestamp	29	The date the transaction was posted.
revision	Long	4	The revision number of the table.
transacted_at	Timestamp	29	The date the transaction occurred.
updated_at	Timestamp	29	The date and time the transaction was last updated.

Goals

The goals object is used to create and manage financial goals.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the goal.
account_guid	String	40	(Foreign Key to accounts.guid) The GUID of the account associated with the goal.
account_id	String	255	The unique partner-defined identifier for the account.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user.
user_id	String	255	The partner-defined identifier for the user.
amount	Double	14,2	The target amount for the goal.
completed_at	Timestamp	29	The timestamp when the goal was completed.
created_at	Timestamp	29	The date and time the goal was created.
created_by	String	4	The entity that created the goal (e.g., USER).
current_amount	Double	14,2	The current amount saved towards the goal.
goal_type	String	255	The type of goal.
has_been_spent	Boolean		Indicates if the goal amount has been spent.
is_complete	Boolean		Indicates if the goal is complete.
meta_type	String	255	The meta type of the goal.
metadata	String	4096	Additional information a partner can store on the goal.
name	String	80	The name of the goal.
position	Long	4	The position of the goal in a list.
projected_to_complete_at	Timestamp	29	The projected completion date.
revision	Long	4	The revision number of the goal.
updated_at	Timestamp	29	The date and time the goal was last updated.

Holdings

The holdings object contains information about a user's investment holdings.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the holding.
id	String	255	The partner-defined identifier for the holding.
account_guid	String	40	(Foreign Key to accounts.guid) The GUID of the account for the holding.
account_id	String	255	The unique partner-defined identifier for the account.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user.
user_id	String	255	The partner-defined identifier for the user.
bond_coupon_rate	Double	10,6	The coupon rate for a bond holding.
bond_maturity_date	Timestamp	29	The maturity date for a bond holding.
cost_basis	Double	14,2	The original value of an asset for tax purposes, usually the purchase price, used to calculate capital gains or losses. Accumulated price.
created_at	Timestamp	29	The date and time the holding was created.
daily_change	Double	10,2	The daily change in the current_price of the holding since the previous trading day.
deleted_at	Timestamp	29	The date and time the holding was deleted.
description	String	1024	A brief description of the holding, such as the company name for stocks or the bond type for bonds.
equity_classification	String	255	The equity classification of the holding.
fixed_income_classification	String	255	The fixed income classification of the holding.
holding_type	String	255	The type of investment (e.g., equity, fixed income, mutual fund, etc.).
is_deleted	Boolean		Indicates if the holding has been deleted.
isin	String	255	The ISIN of the holding.
market_value	Double	14,2	The current market value of the holding, calculated as the current price times the number of units (shares) owned.
member_is_managed_by_user	Boolean		Indicates if the member is managed by the user.
metadata	String	4096	Additional information a partner can store on the holding.
purchase_price	Double	10,2	The purchase price of the holding.
revision	Long	4	The revision number of the holding.
sector	String	255	The sector of the holding.
sedol	String	255	The SEDOL of the holding.
shares	Double	14,2	The number of shares.
symbol	String	255	The ticker symbol or unique identifier of the holding, used in stock exchanges.
updated_at	Timestamp	29	The date and time the holding was last updated.

Insights

The insights object is used to view and manage financial insights.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the insight.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user.
user_id	String	255	The partner-defined identifier for the user.
active_at	Timestamp	29	The date and time the insight becomes active.
created_at	Timestamp	29	The date and time the insight was created.
description	String	1024	The description of the insight.
has_associated_accounts	Boolean		Indicates if the insight has associated accounts.
has_associated_categories	Boolean		Indicates if the insight has associated categories.
has_associated_merchants	Boolean		Indicates if the insight has associated merchants.
has_associated_scheduled_payments	Boolean		Indicates if the insight has associated scheduled payments.
has_associated_transactions	Boolean		Indicates if the insight has associated transactions.
has_been_displayed	Boolean		Indicates if the insight has been displayed.
is_dismissed	Boolean		Indicates if the insight has been dismissed.
micro_call_to_action	String	255	The micro call to action for the insight.
micro_description	String	1024	The micro description of the insight.
micro_title	String	1024	The micro title of the insight.
template	String	255	The template used for the insight.
title	String	255	The title of the insight.
updated_at	Timestamp	29	The date and time the insight was last updated.

Members

A member represents a user's login at a financial institution. A user may have one or more members. For example, a user may have a login at Chase and a separate login at Wells Fargo; this user would have two members. Each member is associated with one and only one user.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the member. Defined by MX.
id	String	255	The unique partner-defined identifier for the member.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
institution_guid	String	40	The unique identifier for the institution this member belongs to. Defined by MX.
institution_id	String	255	The unique partner-defined identifier for the institution.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user that this member belongs to.
user_id	String	255	The unique partner-defined identifier for the user.
connection_status	String	255	The connection status of the member (e.g., CONNECTED, CHALLENGED, DENIED).
connection_status_id	Long	4	This indicates the state of a member's aggregation. This field will reflect the value as of the time that the daily files were generated, which is around midnight UTC.
connection_status_message	String	255	A message describing the connection status.
created_at	Timestamp	29	The date and time the member was created.
institution_code	String	255	A more human-friendly identifier for the institution that this member is associated with. Defined by MX.
is_managed_by_user	Boolean		This indicates whether the associated member is managed by the user or the MX partner. Members created with the managed member feature will have this field set to false.
is_manual	Boolean		Indicates if the member was created manually.
metadata	String	4096	Additional information a partner can store on the member.
name	String	80	The name of the member.
revision	Long	4	The revision number of the member record.
successfully_aggregated_at	Timestamp	29	The date and time the member was last successfully aggregated.
updated_at	Timestamp	29	The date and time the member was last updated.
use_cases	Array (String)	255	A list of use cases for the member.

Merchant Locations

The merchant_locations object contains information about a merchant's location.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the merchant location.
merchant_guid	String	40	(Foreign Key to merchants.guid) The unique identifier for the merchant.
city	String	255	The city of the merchant location.
country	String	255	The country of the merchant location.
created_at	Timestamp	29	The date and time the merchant location was created.
latitude	Double	15,12	The latitude of the merchant location.
longitude	Double	15,12	The longitude of the merchant location.
phone_number	String	255	The phone number of the merchant location.
postal_code	String	255	The postal code of the merchant location.
state	String	255	The state or province of the merchant location.
street_address	String	255	The street address of the merchant location.
updated_at	Timestamp	29	The date and time the merchant location was last updated.

Merchants

The merchants object contains information about a merchant.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the merchant. Defined by MX.
created_at	Timestamp	29	The date and time the merchant was created.
logo_url	String	1024	The URL for the merchant's logo.
merchant_category_code	Long	4	The ISO 18245 category code for the transaction.
name	String	80	The name of the merchant.
updated_at	Timestamp	29	The date and time the merchant was last updated.
website_url	String	1024	The URL for the merchant's website.

Model Reason Codes

The model_reason_codes object stores reason codes for model results.

note

The fields in this table will be null for this iteration.

Field	Type	Length	Description
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user.
user_id	String	255	The partner-defined identifier for the user.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
reason_code	String	255	The specific reason code.
reason_code_definition	String	255	The definition of the reason code.
reason_code_name	String	1024	The name of the reason code.
updated_at	Timestamp	29	The date and time the reason code was last updated.

Model Results

The model_results object stores results from various financial models.

note

The fields in this table will be null for this iteration.

Field	Type	Length	Description
user_guid	String	40	(Primary Key, Foreign Key to users.guid) The unique identifier for the user.
user_id	String	255	The partner-defined identifier for the user.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
attrition_reason_codes	String	255	A delimited list of the reason codes that apply to the user.
attrition_risk_tier	String	255	The name of the risk tier that the user belongs to, given the risk score.
attrition_score	Long	10	The score calculated by the deposit attrition model.
finstrong_score	Long	4	The score generated by the Finstrong process.
generation	String	255	An indication of the user's demographic generation.
movers_likely_moved_on	Date	10	The most recent date where a highly likely move was detected for the user.
movers_reason_codes	String	255	Reason codes associated with the movers score.
movers_score	Long	10	The confidence score for this prediction.
primacy_score	Long	10	The primacy score generated as part of the Customer Analytics process.
spend_to_income_3_month_income	Double	10,2	The average monthly income of the user over the 3 month period used for the spend-to-income calculation.
spend_to_income_3_month_spend	Double	10,2	The average monthly spend of the user over the 3 month period used for the spend-to-income calculation.
spend_to_income_date	Date	10	The end date of the 3 month period over which the spend-to-income ratio was calculated.
spend_to_income_ratio	Double	16,10	The 3 month spend-to-income ratio for the user, expressed as a decimal.
spend_to_income_reason_codes	String	255	A delimited list of the reason codes that apply to the user.
updated_at	Timestamp	29	The date and time the model results were last updated.

Notification Profiles

The notification_profiles object stores user notification preferences.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the notification profile.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
entity_guid	String	40	The GUID of the entity the notification is for.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user.
user_id	String	255	The partner-defined identifier for the user.
created_at	Timestamp	29	The date and time the profile was created.
email_channel	Boolean		The email channel setting.
is_enabled	Boolean		Indicates if the notification is enabled.
last_recorded_at	Timestamp	29	The last time the notification was recorded.
notification_type	String	255	The type of notification.
push_channel	Boolean		The push notification channel setting.
scheduled_for	Timestamp	29	The time the notification is scheduled for.
sms_channel	Boolean		The SMS channel setting.
threshold	Double	10,2	The threshold for the notification.
updated_at	Timestamp	29	The date and time the profile was last updated.

Spending Plan Accounts

The spending_plan_accounts object links accounts to spending plans.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the spending plan account relationship.
account_guid	String	40	(Foreign Key to accounts.guid) The GUID of the account.
account_id	String	255	The unique partner-defined identifier for the account.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
spending_plan_guid	String	40	(Foreign Key to spending_plans.guid) The GUID of the spending plan.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user.
user_id	String	255	The partner-defined identifier for the user.
created_at	Timestamp	29	The date and time the relationship was created.
updated_at	Timestamp	29	The date and time the relationship was last updated.

Spending Plan Iteration Items

The spending_plan_iteration_items object represents individual items within a spending plan iteration.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the spending plan iteration item.
category_guid	String	40	(Foreign Key to categories.guid) The GUID of the category for the item.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
scheduled_payment_guid	String	40	The GUID of the scheduled payment for the item.
spending_plan_iteration_guid	String	40	(Foreign Key to spending_plan_iterations.guid) The GUID of the spending plan iteration.
top_level_category_guid	String	40	(Foreign Key to categories.guid) The GUID of the top level category for the item.
transaction_guids	Array (String)	65,535	(List of Foreign Keys to transactions.guid) The GUID of the transactions for the item.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user.
user_id	String	255	The partner-defined identifier for the user.
actual_amount	Double	14,2	The actual amount for the item.
created_at	Timestamp	29	The date and time the item was created.
item_type	String	255	The type of the item.
planned_amount	Double	14,2	The planned amount for the item.
updated_at	Timestamp	29	The date and time the item was last updated.

Spending Plan Iterations

The spending_plan_iterations object represents iterations of a spending plan.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the spending plan iteration.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
spending_plan_guid	String	40	(Foreign Key to spending_plans.guid) The GUID of the spending plan.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user.
user_id	String	255	The partner-defined identifier for the user.
created_at	Timestamp	29	The date and time the spending plan was created.
end_on	Date	10	The end date of the iteration.
iteration_number	Long	4	The number of the iteration.
start_on	Date	10	The start date of the iteration.
updated_at	Timestamp	29	The date and time the iteration was last updated.

Spending Plans

The spending_plans object is used to create and manage spending plans.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the spending plan.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user.
user_id	String	255	The partner-defined identifier for the user.
created_at	Timestamp	29	The date and time the spending plan was created.
current_iteration_number	Long	4	The current iteration number of the spending plan.
updated_at	Timestamp	29	The date and time the spending plan was last updated.

Taggings

The taggings object represents the association between a tag and a transaction.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the tagging.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
tag_guid	String	40	(Foreign Key to tags.guid) The GUID of the tag.
transaction_guid	String	40	(Foreign Key to transactions.guid) The GUID of the transaction being tagged.
transaction_id	String	4	The unique partner-defined identifier for the transaction.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user.
user_id	String	255	The partner-defined identifier for the user.
member_is_managed_by_user	Boolean		Indicates if the member is managed by the user.
revision	Long	4	The revision number of the tagging.
updated_at	Timestamp	29	The date and time the tagging was last updated.

Tags

The tags object is used to create and manage tags.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the tag.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user.
user_id	String	255	The partner-defined identifier for the user.
name	String	80	The name of the tag.
revision	Long	4	The revision number of the tag.
updated_at	Timestamp	29	The date and time the tag was last updated.

Top Merchants

The top_merchants object stores information about a user's top merchants.

note

The fields in this table will be null for this iteration.

Field	Type	Length	Description
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
merchant_guid	String	40	(Foreign Key to merchants.guid) The unique identifier for the merchant.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user.
user_id	String	255	The partner-defined identifier for the user.
merchant_user_rank	Long	4	The numerical rank for the merchant with the user (1-3).
merchant_user_rank_category	String	255	The category for the user's merchant rank.
merchant_user_ranking_date	Date	10	The date the ranking was calculated.
merchant_website_url	String	1024	The website URL of the merchant.
name	String	80	The name of the merchant.
transaction_average_amount	Double	10,2	The average transaction absolute value of the transaction amounts the user had with the merchant
transaction_count	Long	10	The count of transactions the user had with the merchant in the previous month
updated_at	Timestamp	29	The date and time the top merchant data was last updated.

Transactions

A transaction represents a financial transaction. A transaction is always associated with one account.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the transaction. Defined by MX.
id	String	255	The unique partner-defined identifier for the transaction.
account_guid	String	40	(Foreign Key to accounts.guid) The unique identifier for the account associated with the transaction. Defined by MX.
account_id	String	255	The unique partner-defined identifier for the account.
category_guid	String	40	(Foreign Key to categories.guid) The unique identifier for the category assigned to the transaction.
classification_guid	String	40	(Foreign Key to classifications.guid) The unique identifier for the classification assigned to the transaction.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
member_guid	String	40	(Foreign Key to members.guid) The unique identifier for the member associated with the transaction. Defined by MX.
member_id	String	255	The unique partner-defined identifier for the member.
merchant_guid	String	40	(Foreign Key to merchants.guid) The unique identifier for the merchant associated with this transaction. Defined by MX.
merchant_location_guid	String	40	(Foreign Key to merchant_locations.guid) The unique identifier for the merchant_location associated with this transaction. Defined by MX.
parent_guid	String	40	(Foreign Key to transactions.guid) The unique identifier for the parent transaction associated with a split transaction.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user associated with this transaction. Defined by MX.
user_id	String	255	The partner-defined identifier for the user.
amount	Double	10,2	The monetary amount of the transaction.
created_at	Timestamp	29	The date and time the transaction was created.
feed_description	String	1024	The original description of the transaction as provided by the institution.
feed_transaction_type	String	255	The transaction type provided by the data feed.
member_is_managed_by_user	Boolean		This indicates whether the associated member is managed by the user or the MX partner.
memo	String	1024	This field contains additional descriptive information about the transaction.
metadata	String	4096	Additional information a partner can store on the transaction.
revision	Long	4	The revision number of the table.
status	String	4	The status of the transaction. This will be either POSTED or PENDING.
transacted_at	Timestamp	29	The date and time the transaction took place.
transaction_type	String	255	The type of transaction. This will be either CREDIT or DEBIT.
updated_at	Timestamp	29	The date and time the transaction was last updated.

Transaction Details

This table contains additional, more detailed information about a transaction.

Field	Type	Length	Description
guid	String	40	(Primary Key, Foreign Key to transactions.guid) The unique identifier for the transaction detail record, which is the same as the transaction GUID.
id	String	255	The unique partner-defined identifier for the transaction.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user associated with this transaction.
user_id	String	255	The partner-defined identifier for the user.
check_number_string	String	255	The check number for the transaction.
currency_code	String	255	The currency in which the holding is denominated.
description	String	1024	A human-readable version of the original_description field described below, e.g., "Sam's Club," "Johnny's Tavern." This is provided by the MX Platform.
extended_transaction_type	String	255	The transaction type assigned by the partner.
feed_localized_description	String	1024	The original description of the transaction as provided by our data feed, given in a local language. See description above for more information.
feed_localized_memo	String	1024	The original memo of the transaction as provided by our data feed, given in a local language.
has_been_split	Boolean		Indicates if the transaction has been split.
has_been_viewed	Boolean		Indicates if the transaction has been viewed by the user.
is_bill_pay	Boolean		This indicates whether the transaction represents a bill pay.
is_direct_deposit	Boolean		This indicates whether the transaction represents a direct deposit.
is_expense	Boolean		This indicates whether the transaction represents an expense.
is_fee	Boolean		This indicates whether the transaction represents a fee.
is_flagged	Boolean		Indicates if the transaction has been flagged by the user.
is_hidden	Boolean		Indicates if the transaction is hidden.
is_income	Boolean		This indicates whether the transaction represents income.
is_international	Boolean		Indicates if the transaction is local or international.
is_manual	Boolean		Indicates if the transaction was created manually.
is_overdraft_fee	Boolean		Indicates if the transaction represents an overdraft fee.
is_payroll_advance	Boolean		Indicates if the transaction represents a payroll advance.
is_personal	Boolean		Indicates if the transaction is personal.
is_subscription	Boolean		This indicates whether the transaction represents a payment for a subscription service such as Netflix or Audible.
localized_description	String	1024	The description of the transaction, localized to the user's language.
localized_memo	String	1024	The memo of the transaction, localized to the user's language.
posted_at	Timestamp	29	The date and time the transaction was posted to the account.
transaction_revision	Long	4	The revision number of the transaction record.
updated_at	Timestamp	29	The date and time the transaction details were last updated.

User Affinities

The user_affinities object stores user affinities to merchants and brands.

note

The fields in this table will be null for this iteration.

Field	Type	Length	Description
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user.
user_id	String	255	The partner-defined identifier for the user.
updated_at	Timestamp	29	The date and time the user affinity data was last updated.
user_affinity_date	Date	10	The date the affinity was calculated.
user_affinity_name	String	255	The name of the affinity (e.g., a brand or merchant).
user_affinity_rank	Long	4	The rank of this affinity for the user (1-3).
user_affinity_transaction_amount_total	Double	16,2	The total amount (absolute value) of the transactions the user had in the affinity group during the previous month.
user_affinity_transaction_count	Long	4	The count of transactions the user had in the affinity group during the previous month.

User Communication Profiles

The user_communication_profiles object stores user communication preferences.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the user communication profile.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
user_guid	String	40	(Foreign Key to users.guid) The unique identifier for the user.
user_id	String	255	The unique partner-defined identifier for the user.
created_at	Timestamp	29	The date and time the profile was created.
opted_out_of_all_notifications	Boolean		Indicates if the user opted out of all notifications.
opted_out_of_all_notifications_updated_at	Timestamp	29	The time the user opted out of all notifications.
opted_out_of_email_notifications	Boolean		Indicates if the user opted out of email notifications.
opted_out_of_email_notifications_updated_at	Timestamp	29	The time the user opted out of email notifications.
opted_out_of_push_notifications	Boolean		Indicates if the user opted out of push notifications.
opted_out_of_push_notifications_updated_at	Timestamp	29	The time the user opted out of push notifications.
opted_out_of_sms_notifications	Boolean		Indicates if the user opted out of SMS notifications.
opted_out_of_sms_notifications_updated_at	Timestamp	29	The time the user opted out of SMS notifications.
updated_at	Timestamp	29	The date and time the profile was last updated.

Users

A user represents an end-user of the MX Platform. A user may have one or more members.

Field	Type	Length	Description
guid	String	40	(Primary Key) The unique identifier for the user. Defined by MX.
id	String	255	The unique partner-defined identifier for the user.
client_guid	String	40	The GUID of the client. Defined by MX.
client_id	String	255	The unique partner-defined identifier for the client.
birthdate	Date	10	The user's date of birth.
created_at	Timestamp	29	The date and time the user was created.
email	String	255	The user's email address.
email_is_verified	Boolean		Indicates if the user's email has been verified.
first_name	String	255	The user's first name.
gender	String	7	The user's gender.
is_disabled	Boolean		Indicates if the user is disabled.
last_name	String	255	The user's last name.
logged_in_at	Timestamp	29	The date and time the user last logged in.
metadata	String	4096	Additional information a partner can store on the user.
phone	String	255	The user's phone number.
phone_is_verified	Boolean		Indicates if the user's phone number has been verified.
postal_code	String	255	The user's postal code.
revision	Long	4	The revision number of the table.
updated_at	Timestamp	29	The date and time the user was last updated.