> ## Documentation Index > Fetch the complete documentation index at: https://docs.mx.com/llms.txt > Use this file to discover all available pages before exploring further. # Accounts Overview > Overview of accounts resource and field definitions The Accounts endpoints represent a user's checking, savings, mortgage, 401(k), or other types of accounts held by a financial institution. An account belongs to a `member`, which represents the user's overall relationship with a particular financial institution. ## Accounts Fields | **Field** | **Type** | **Description** | | :------------------------------------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `account_guid` | String | Unique identifier for the account. Defined by MX. | | `account_holder_name` | String | The name of the account holder. | | `account_number` | String | The account number, as provided by our data feed. | | `account_subtype` | Integer | The integer value of the account subtype. | | `account_subtype_name` | String | The account subtype (for example, PLAN\_401\_K, MONEY\_MARKET, or HOME\_EQUITY). | | `account_type` | Integer | The integer value of the account type. | | `account_type_name` | String | The account type (for example, CHECKING, SAVINGS, CREDIT\_CARD). | | `available_balance` | Decimal | The balance that is available for use in asset accounts like checking and savings. `PENDING` transactions are typically taken into account with the available balance, but this may not always be the case. `available_balance` will usually be a positive value for all account types, determined in the same way as the `balance` field. | | `balance` | Decimal | The current balance of the account. `PENDING` transactions are typically not taken into account with the current balance, but this may not always be the case. This is the value used for the account balance displayed in MX UIs. The balance will usually be a positive value for all account types. Asset-type accounts (`CHECKING`, `SAVINGS`, `INVESTMENT`) may have a negative balance if they are in overdraft. Debt-type accounts (`CREDIT_CARD`, `LOAN`, `LINE_OF_CREDIT`, `MORTGAGE`) may have a negative balance if they are overpaid. | | `created_at` | String | Date and time the account was created, represented in ISO 8601 format with timestamp (for example, 2015-04-13T12:01:23-00:00). | | `currency_code` | String | The currency code associated with the account (for example, USD, EUR). | | `federal_insurance_status` | String | The federal insurance status of the account. Indicates whether the account is insured by the FDIC (banks) or NCUA (credit unions). See the section on [federal insurance status](/api-reference/nexus/reference/01-accounts-overview#federal-insurance-status) for more information | | `federal_insurance_status_set_by` | String | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See the section on [account fields with set by](/api-reference/nexus/reference/01-accounts-overview#account-fields-with-set_by-or-set_by_name) for more information. | | `federal_insurance_status_set_by_name` | String | The source that set the data (FEED, USER, or SYSTEM). See the section on [account fields with set by](/api-reference/nexus/reference/01-accounts-overview#account-fields-with-set_by-or-set_by_name) for more information. | | `feed_account_number` | String | The account number, as provided by our data feed. | | `feed_name` | String | The name of the account, as provided by our data feed. | | `feed_original_balance` | Decimal | The original balance, as provided by our data feed. Max length is 14,2. See [Number Limits](/api-reference/nexus/#numbers-limits). | | `feed_payment_due_at` | String | Date and time the payment is due at, as provided by our data feed. Represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00). | | `feed_payoff_balance` | Decimal | The payoff balance, as provided by our data feed. Max length is 14,2. See [Number Limits](/api-reference/nexus/#numbers-limits). | | `feed_routing_number` | String | The routing number, as provided by our data feed. See routing\_number for more information. | | `feed_started_on` | String | The started on date, as provided by our data feed. Represented in ISO 8601 format (e.g. 2011-03-28). | | `feed_statement_balance` | Decimal | The account statement balance, as provided by our data feed. Max length is 14,2. See [Number Limits](/api-reference/nexus/#numbers-limits). | | `feed_total_account_value` | Decimal | The sum of the long and short positions, the sweep account and/or cash balance, and any margin debt associated with a particular account. This amount includes the market value of all positions held in the account and is reduced by any debit balance and the amount of short options positions that are "in the money". This may sum to a negative value, and it does not represent an account balance. Max length is 14,2. See [Number Limits](/api-reference/nexus/#numbers-limits). | | `guid` | String | Unique identifier for the account. Defined by MX. | | `holdings_value` | Decimal | The value of holdings with this account. | | `holdings_value_set_by` | Integer | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information. | | `holdings_value_set_by_name` | String | The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information. | | `institution_guid` | String | Unique identifier for the institution the account is attached to. Defined by MX. | | `insured_name` | String | The name of the insured individual. | | `interest_rate` | Decimal | Interest rate (e.g. 2.99% is passed as 2.99). Max length is 10,6. See [Number Limits](/api-reference/nexus/#numbers-limits). | | `interest_rate_set_by` | Integer | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information. | | `interest_rate_set_by_name` | String | The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information. | | `is_closed` | Boolean | If an account is closed, this field will be true. Otherwise, this field will be false. | | `is_hidden` | Boolean | If an account is hidden, this field will be true. Otherwise, this field will be false. All linked transactions will be hidden as well. | | `is_manual` | Boolean | If an account was manually created, this field will be true. Otherwise, this field will be false. | | `last_payment` | Decimal | Amount of the account's last payment. Max length is 10,2. See [Number Limits](/api-reference/nexus/#numbers-limits). | | `last_payment_at` | String | Date and time the account's last payment was applied, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00). | | `last_payment_at_set_by` | Integer | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information. | | `last_payment_at_set_by_name` | String | The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information. | | `last_payment_set_by` | Integer | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information. | | `last_payment_set_by_name` | String | The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information. | | `loan_amount` | Decimal | Amount of the loan. Max length is 14,2. See [Number Limits](/api-reference/nexus/#numbers-limits). | | `loan_amount_set_by` | Integer | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information. | | `loan_amount_set_by_name` | String | The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information. | | `matures_on` | String | Maturity date. Represented in ISO 8601 format (for example, 2011-03-28). | | `matures_on_set_by` | Integer | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information. | | `matures_on_set_by_name` | String | The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information. | | `metadata` | String | Additional information or details about the account. This may be overwritten by the data provider when data is refreshed through aggregation. | | `minimum_payment` | Decimal | Minimum payment amount. Max length is 10,2. See [Number Limits](/api-reference/nexus/#numbers-limits). | | `minimum_payment_at` | String | Date and time the minimum payment is due. Represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00). | | `minimum_payment_at_set_by` | Integer | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information. | | `minimum_payment_at_set_by_name` | String | The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information. | | `minimum_payment_set_by` | Integer | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information. | | `minimum_payment_set_by_name` | String | The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information. | | `name` | String | The name of the account. | | `nickname` | String | The nickname is an alternate name for the account. This value is visible to the user and must be human-readable. | | `original_balance` | Decimal | The original balance of the account. Max length is 14,2. See [Number Limits](/api-reference/nexus/#numbers-limits). | | `original_balance_set_by` | Integer | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information. | | `original_balance_set_by_name` | String | The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information. | | `payment_due_at` | String | Date and time the payment is due. Represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00). | | `payoff_balance` | Decimal | The payoff balance of the account. Max length is 14,2. See [Number Limits](/api-reference/nexus/#numbers-limits). | | `payoff_balance_set_by` | Integer | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information. | | `payoff_balance_set_by_name` | String | The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information. | | `principal_balance` | Decimal | The principal balance of the account. Max length is 14,2. See [Number Limits](/api-reference/nexus/#numbers-limits). | | `principal_balance_set_by` | Integer | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information. | | `principal_balance_set_by_name` | String | The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information. | | `started_on` | String | The started on date. Represented in ISO 8601 format (for example, 2011-03-28). | | `started_on_set_by` | Integer | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information. | | `started_on_set_by_name` | String | The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information. | | `statement_balance` | Decimal | The account statement balance. Max length is 14,2. See [Number Limits](/api-reference/nexus/#numbers-limits). | | `statement_balance_set_by` | Integer | The source that set the data (1 = FEED, 2 = USER, 3 = SYSTEM). See Account Set By for more information. | | `statement_balance_set_by_name` | String | The source that set the data (FEED, USER, or SYSTEM). See Account Set By for more information. | | `total_account_value` | Decimal | The sum of the long and short positions, the sweep account and/or cash balance, and any margin debt associated with a particular account. This amount includes the market value of all positions held in the account and is reduced by any debit balance and the amount of short options positions that are "in the money". This may sum to a negative value, and it does not represent an account balance. Max length is 14,2. See [Number Limits](/api-reference/nexus/#numbers-limits). | | `updated_at` | String | Date and time the account was last updated, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00). | ## Account fields with `set_by` or `set_by_name` The `set_by` fields return an Integer and the `set_by_name` fields return a String. The table below shows the meaning of each value and how the Integers map to the Strings. See the Accounts sections in Endpoints for examples. | set\_by Integer | set\_by String | Information | | :-------------- | :------------- | :------------------------------------------ | | 1 | FEED | Information provided from the MX data feed. | | 2 | USER | Information provided from the user. | | 3 | SYSTEM | Information provided from the MX system. | ## Account Types The `account_type` and `feed_account_type` fields of the Accounts endpoint return Integers. The `account_type_name` and `feed_account_type_name` fields return Strings. See the table below for the meaning behind each value.ß | Account type Integer | Account type String | | :------------------- | :------------------------------------------------------------ | | 0 | ANY (not provided by data partner or invalid number provided) | | 1 | CHECKING | | 2 | SAVINGS | | 3 | LOAN | | 4 | CREDIT\_CARD | | 5 | INVESTMENT | | 6 | LINE\_OF\_CREDIT | | 7 | MORTGAGE | | 8 | PROPERTY | | 9 | CASH | | 10 | INSURANCE | | 11 | PREPAID | | 12 | CHECKING\_LINE\_OF\_CREDIT | | 13 | DIGITAL\_WALLET | ## Account Subtypes The `account_subtype` and `feed_account_subtype` fields of the Accounts endpoint return Integers. The `account_subtype_name` and `feed_account_subtype_name` fields return Strings. See the table below for the meaning behind each value. Some account types have defined subtypes. | Subtype Integer | Subtype String | Parent type String | | :-------------- | :--------------------------------------------- | :----------------- | | 1 | MONEY\_MARKET | SAVINGS | | 2 | CERTIFICATE\_OF\_DEPOSIT | SAVINGS | | 3 | AUTO | LOAN | | 4 | STUDENT | LOAN | | 5 | SMALL\_BUSINESS | LOAN | | 6 | PERSONAL | LOAN | | 7 | PERSONAL\_WITH\_COLLATERAL | LOAN | | 8 | HOME\_EQUITY | LOAN | | 9 | PLAN\_401\_K | INVESTMENT | | 10 | PLAN\_403\_B | INVESTMENT | | 11 | PLAN\_529 | INVESTMENT | | 12 | IRA | INVESTMENT | | 13 | ROLLOVER\_IRA | INVESTMENT | | 14 | ROTH\_IRA | INVESTMENT | | 15 | TAXABLE | INVESTMENT | | 16 | NON\_TAXABLE | INVESTMENT | | 17 | BROKERAGE | INVESTMENT | | 18 | TRUST | INVESTMENT | | 19 | UNIFORM\_GIFTS\_TO\_MINORS\_ACT | INVESTMENT | | 20 | PLAN\_457 | INVESTMENT | | 21 | PENSION | INVESTMENT | | 22 | EMPLOYEE\_STOCK\_OWNERSHIP\_PLAN | INVESTMENT | | 23 | SIMPLIFIED\_EMPLOYEE\_PENSION | INVESTMENT | | 24 | SIMPLE\_IRA | INVESTMENT | | 25 | BOAT | LOAN | | 26 | POWERSPORTS | LOAN | | 27 | RV | LOAN | | 28 | HELOC | LOAN | | 29 | PLAN\_ROTH\_401\_K | INVESTMENT | | 30 | FIXED\_ANNUITY | INVESTMENT | | 31 | VARIABLE\_ANNUITY | INVESTMENT | | 32 | VEHICLE\_INSURANCE | INSURANCE | | 33 | DISABILITY | INSURANCE | | 34 | HEALTH | INSURANCE | | 35 | LONG\_TERM\_CARE | INSURANCE | | 36 | PROPERTY\_AND\_CASUALTY | INSURANCE | | 37 | UNIVERSAL\_LIFE | INSURANCE | | 38 | TERM\_LIFE | INSURANCE | | 39 | WHOLE\_LIFE | INSURANCE | | 40 | ACCIDENTAL\_DEATH\_AND\_DISMEMBERMENT | INSURANCE | | 41 | VARIABLE\_UNIVERSAL\_LIFE | INSURANCE | | 42 | HSA | INVESTMENT | | 43 | TAX\_FREE\_SAVINGS\_ACCOUNT | INVESTMENT | | 44 | INDIVIDUAL | INVESTMENT | | 45 | REGISTERED\_RETIREMENT\_INCOME\_FUND | INVESTMENT | | 46 | CASH\_MANAGEMENT\_ACCOUNT | INVESTMENT | | 47 | EMPLOYEE\_STOCK\_PURCHASE\_PLAN | INVESTMENT | | 48 | REGISTERED\_EDUCATION\_SAVINGS\_PLAN | INVESTMENT | | 49 | PROFIT\_SHARING\_PLAN | INVESTMENT | | 50 | UNIFORM\_TRANSFER\_TO\_MINORS\_ACT | INVESTMENT | | 51 | PLAN\_401\_A | INVESTMENT | | 52 | SARSEP\_IRA | INVESTMENT | | 53 | FIXED\_ANNUITY\_TRADITIONAL\_IRA | INVESTMENT | | 54 | VARIABLE\_ANNUITY\_TRADITIONAL\_IRA | INVESTMENT | | 55 | SEPP\_IRA | INVESTMENT | | 56 | INHERITED\_TRADITIONAL\_IRA | INVESTMENT | | 57 | FIXED\_ANNUITY\_ROTH\_IRA | INVESTMENT | | 58 | VARIABLE\_ANNUITY\_ROTH\_IRA | INVESTMENT | | 59 | INHERITED\_ROTH\_IRA | INVESTMENT | | 60 | COVERDELL | INVESTMENT | | 61 | ADVISORY\_ACCOUNT | INVESTMENT | | 62 | BROKERAGE\_MARGIN | INVESTMENT | | 63 | CHARITABLE\_GIFT\_ACCOUNT | INVESTMENT | | 64 | CHURCH\_ACCOUNT | INVESTMENT | | 65 | CONSERVATORSHIP | INVESTMENT | | 66 | CUSTODIAL | INVESTMENT | | 67 | DEFINED\_BENEFIT\_PLAN | INVESTMENT | | 68 | DEFINED\_CONTRIBUTION\_PLAN | INVESTMENT | | 69 | EDUCATIONAL | INVESTMENT | | 70 | ESTATE | INVESTMENT | | 71 | EXECUTOR | INVESTMENT | | 72 | GROUP\_RETIREMENT\_SAVINGS\_PLAN | INVESTMENT | | 73 | GUARANTEED\_INVESTMENT\_CERTIFICATE | INVESTMENT | | 74 | HRA | INVESTMENT | | 75 | INDEXED\_ANNUITY | INVESTMENT | | 76 | INVESTMENT\_CLUB | INVESTMENT | | 77 | IRREVOCABLE\_TRUST | INVESTMENT | | 78 | JOINT\_TENANTS\_BY\_ENTIRITY | INVESTMENT | | 79 | JOINT\_TENANTS\_COMMUNITY\_PROPERTY | INVESTMENT | | 80 | JOINT\_TENANTS\_IN\_COMMON | INVESTMENT | | 81 | JOINT\_TENANTS\_WITH\_RIGHTS\_OF\_SURVIVORSHIP | INVESTMENT | | 82 | KEOUGH\_PLAN | INVESTMENT | | 83 | LIFE\_INCOME\_FUND | INVESTMENT | | 84 | LIVING\_TRUST | INVESTMENT | | 85 | LOCKED\_IN\_RETIREMENT\_ACCOUNT | INVESTMENT | | 86 | LOCKED\_IN\_RETIREMENT\_INVESTMENT\_FUND | INVESTMENT | | 87 | LOCKED\_IN\_RETIREMENT\_SAVINGS\_ACCOUNT | INVESTMENT | | 88 | MONEY\_PURCHASE\_PLAN | INVESTMENT | | 89 | PARTNERSHIP | INVESTMENT | | 90 | PLAN\_409\_A | INVESTMENT | | 91 | PLAN\_ROTH\_403\_B | INVESTMENT | | 92 | REGISTERED\_DISABILITY\_SAVINGS\_PLAN | INVESTMENT | | 93 | REGISTERED\_LOCKED\_IN\_SAVINGS\_PLAN | INVESTMENT | | 94 | REGISTERED\_PENSION\_PLAN | INVESTMENT | | 95 | REGISTERED\_RETIREMENT\_SAVINGS\_PLAN | INVESTMENT | | 96 | REVOCABLE\_TRUST | INVESTMENT | | 97 | ROTH\_CONVERSION | INVESTMENT | | 98 | SOLE\_PROPRIETORSHIP | INVESTMENT | | 99 | SPOUSAL\_IRA | INVESTMENT | | 100 | SPOUSAL\_ROTH\_IRA | INVESTMENT | | 101 | TESTAMENTARY\_TRUST | INVESTMENT | | 102 | THRIFT\_SAVINGS\_PLAN | INVESTMENT | | 103 | INHERITED\_ANNUITY | INVESTMENT | | 104 | CORPORATE\_ACCOUNT | INVESTMENT | | 105 | LIMITED\_LIABILITY\_ACCOUNT | INVESTMENT | ## Federal Insurance Status The `federal_insurance_status` and `feed_federal_insurance_status` fields of the Accounts endpoint return Integers. The `federal_insurance_status_name` and `feed_federal_insurance_status_name` fields return Strings. | Federal Insurance Status | Definition | | :----------------------- | :--------------- | | 0 | UNKNOWN\_INSURED | | 1 | INSURED | | 2 | NOT\_INSURED | ## Interest Rate Source The `interest_rate_source` field of the Accounts endpoint will return an Integer. See the table below for the meaning behind each Integer: | Interest Rate Source | Definition | | :------------------- | :----------------------------- | | 0 | INTEREST\_RATE\_SOURCE\_SYSTEM | | 1 | INTEREST\_RATE\_SOURCE\_FEED | | 2 | INTEREST\_RATE\_SOURCE\_USER | ## Property Types The `property_type` field of the Accounts endpoint returns an Integer. The `property_type_name` field returns a String. See the table below for the meaning behind each value. | Property Type Integer | Property Type String | | :-------------------- | :------------------- | | 0 | REAL\_ESTATE | | 1 | VEHICLE | | 2 | ART | | 3 | JEWELRY | | 4 | FURNITURE | | 5 | APPLIANCES | | 6 | COMPUTER | | 7 | ELECTRONICS | | 8 | SPORTS\_EQUIPMENT | | 9 | MISCELLANEOUS |