> ## 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.

# Member

> Members represent the connection between a user and a financial institution.

Members represent the connection between a `user` and a financial institution.

Batch is only used to create member connections to a user's home institution. This usually means you'll only create one `member` per `user` using Batch. For details, please contact the MX Integrations team.

## 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, dashes, and underscores. Max Length: 1024.           |
| `is_disabled` | Boolean   | 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, all their members are automatically disabled. Re-enabling the user will re-enable their members. |
| `metadata`    | String    | Additional information you can store on the member.                                                                                                                                                                                                                                      |
| `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    | A unique value sent to your MDX On Demand service to authenticate an aggregation request for a specific user. Preferred over login/password.                                                                                                                                             |

## Member File Parameters

<Note>
  The `action` field tells us what data operation to perform for each row in the file. Options are `upsert` (an insert/update depending on if the object already exists) and `delete` (which will destroy the record). If no action is provided the default action is `upsert`.
</Note>

<Note>
  The `skip_webhook` parameter prevents a webhook being sent for the action effected by each row. Accepted values are `true` or `false`. If `skip_webhook` is not provided, MX will default to your internal batch configuration setting.
</Note>

| Field          | Required for Upsert? | Required for Delete? | Type    |
| :------------- | :------------------- | :------------------- | :------ |
| `id`           | **Yes**              | **Yes**              | String  |
| `user_id`      | **Yes**              | **Yes**              | String  |
| `action`       | No                   | No                   | String  |
| `is_disabled`  | No                   | No                   | Boolean |
| `metadata`     | No                   | No                   | String  |
| `skip_webhook` | No                   | No                   | Boolean |
| `userkey`      | No                   | No                   | String  |

## Sample File

The following is a sample Member batch CSV file.

```text CSV theme={null}
"action","id","user_id","userkey"
"upsert","M-39XBF7","U-39XBF7","K-39XBF7"
```
