| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | User identifier | |
| password | str | User's password. Please note that some services may return a distorted password, where each symbol is just shown as an 'X' character, i.e. if the user's password is '123456', a service may return the string 'XXXXXX'. See the documentation of individual services to find out whether the password is returned in a distorted form or not. | |
| str | User's email address | [optional] | |
| phone | str | User's phone number | [optional] |
| is_auto_update_enabled | bool | Whether the user's bank connections will get updated in the course of finAPI's automatic batch update. Note that the automatic batch update will only update bank connections where all of the following applies:</br></br> - the PIN is stored in finAPI for the bank connection</br> - the previous update using the stored credentials did not fail due to the credentials being incorrect (or there was no previous update with the stored credentials)</br> - the bank that the bank connection relates to is included in the automatic batch update (please contact your Sys-Admin for details about the batch update configuration)</br> - at least one of the bank's supported data sources can be used by finAPI for your client (i.e.: if a bank supports only web scraping, but web scraping is disabled for your client, then bank connections of that bank will not get updated by the automatic batch update)</br></br>Also note that the automatic batch update must generally be enabled for your client in order for this field to have any effect.<br/><br/>WARNING: The automatic update will always download transactions and security positions for any account that it updates! This means that the user will no longer be able to download just the balances for his accounts once the automatic update has run (The 'skipPositionsDownload' flag in the bankConnections/update service can no longer be set to true). | [default to False] |