Skip to content

Latest commit

 

History

History
13 lines (10 loc) · 2.42 KB

User.md

File metadata and controls

13 lines (10 loc) · 2.42 KB

# User

Properties

Name Type Description Notes
id string User identifier
password string User's password. Please note that some services may return a distorted password (always 'XXXXX'). See the documentation of individual services to find out whether the password is returned as plain text or as 'XXXXX'.
email string User's email address [optional]
phone string 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> - a valid consent exists OR the PIN is stored in finAPI for the bank connection, and the related bank does not have volatile PINs (see the 'isVolatile' flag of the 'loginCredentials')<br/> - the user has accepted the latest Terms and Conditions (this only applies to users whose mandator doesn't have an AIS license)<br> - the bank connection interface flag 'userActionRequired' has to be false<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 for this field to have any effect.<br/><br/>WARNING: The automatic update will always download balances, transactions and security positions for any account that it updates, even if the account was previously imported or updated with 'skipBalancesDownload’ = true and/or ‘skipPositionsDownload' = true.

[Back to Model list] [Back to API list] [Back to README]