# FinApiAccess.ClientConfiguration ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **isAutomaticBatchUpdateEnabled** | **Boolean** | Whether finAPI performs a regular automatic update of your users' bank connections. To find out how the automatic batch update is configured for your client, i.e. which bank connections get updated, and at which time and interval, please contact your Sys-Admin. Note that even if the automatic batch update is enabled for your client, individual users can still disable the feature for their own bank connections. | **isDevelopmentModeEnabled** | **Boolean** | Whether development mode is enabled. This setting is enabled on mandator level and allows any user to access the ‘Mock batch update’ service.

NOTE: This flag is meant for testing purposes during development of your application.
This is why this will never be enabled on a production environment. | **isNonEuroAccountsSupported** | **Boolean** | Whether users are allowed to download accounts with non-euro currencies.
In case the flag is false, then such accounts will be skipped and will NOT appear in the account list. | **isAutoCategorizationEnabled** | **Boolean** | Whether transactions will be categorized as soon as they are downloaded.
In case this flag is false, the user needs to manually trigger categorization using the ‘Trigger categorization’ service. | **mandatorLicense** | **String** | The license associated with your client.
Licenses are administered by finAPI. Please contact the support if you disagree with the license that was set up for you.
Possible values are:
UNLICENSED: The finAPI web form is initiated both for account information services (AIS) and payment initiation services (PIS), if banking credentials or a TAN have to get collected from the user.
AISP: The finAPI web form is initiated only for payment services, as you are licensed for AIS yourself.
PISP: The finAPI web form is initiated only for account information services, as you are licensed for PIS yourself.
FULLY_LICENSED: The finAPI web form is never required, as you are both licensed as AISP and PISP.
UNLICENSED_WITHOUT_WEBFORM: The finAPI web form is never required, because you have committed to work only with your personal account. This license is not allowed to be used in a multi-user scenario.
FULLY_LICENSED_WITH_WEBFORM: This is not yet implemented and just a placeholder. | **preferredConsentType** | **String** | The preferred consent type that will be used for the XS2A interface.

ONETIME - The consent can only be used once to download data associated with the account. The consent won’t be saved by finAPI.
RECURRING - The consent is valid for up to 90 days and can be used by finAPI to access and download account data for up to 4 times per day.

NOTE: If the bank does not support the preferred consent type, then finAPI will default to the other type. | **userNotificationCallbackUrl** | **String** | Callback URL to which finAPI sends the notification messages that are triggered from the automatic batch update of the users' bank connections. This field is only relevant if the automatic batch update is enabled for your client. For details about what the notification messages look like, please see the documentation in the 'Notification Rules' section. finAPI will call this URL with HTTP method POST. Note that the response of the call is not processed by finAPI. Also note that while the callback URL may be a non-secured (http) URL on the finAPI sandbox or alpha environment, it MUST be a SSL-secured (https) URL on the finAPI live system. | [optional] **userSynchronizationCallbackUrl** | **String** | Callback URL for user synchronization. This field should be set if you - as a finAPI customer - have multiple clients using finAPI. In such case, all of your clients will share the same user base, making it possible for a user to be created in one client, but then deleted in another. To keep the client-side user data consistent in all clients, you should set a callback URL for each client. finAPI will send a notification to the callback URL of each client whenever a user of your user base gets deleted. Note that finAPI will send a deletion notification to ALL clients, including the one that made the user deletion request to finAPI. So when deleting a user in finAPI, a client should rely on the callback to delete the user on its own side.

The notification that finAPI sends to the clients' callback URLs will be a POST request, with this body: 

{    \"userId\" : string // contains the identifier of the deleted user    \"event\" : string // this will always be \"DELETED\" }

Note that finAPI does not process the response of this call. Also note that while the callback URL may be a non-secured (http) URL on the finAPI sandbox or alpha environment, it MUST be a SSL-secured (https) URL on the finAPI live system.

As long as you have just one client, you can ignore this field and let it be null. However keep in mind that in this case your client will not receive any callback when a user gets deleted - so the deletion of the user on the client-side must not be forgotten. Of course you may still use the callback URL even for just one client, if you want to implement the deletion of the user on the client-side via the callback from finAPI. | [optional] **refreshTokensValidityPeriod** | **Number** | The validity period that newly requested refresh tokens initially have (in seconds). A value of 0 means that the tokens never expire (Unless explicitly invalidated, e.g. by revocation, or when a user gets locked, or when the password is reset for a user). | [optional] **userAccessTokensValidityPeriod** | **Number** | The validity period that newly requested access tokens for users initially have (in seconds). A value of 0 means that the tokens never expire (Unless explicitly invalidated, e.g. by revocation, or when a user gets locked, or when the password is reset for a user). | [optional] **clientAccessTokensValidityPeriod** | **Number** | The validity period that newly requested access tokens for clients initially have (in seconds). A value of 0 means that the tokens never expire (Unless explicitly invalidated, e.g. by revocation). | [optional] **maxUserLoginAttempts** | **Number** | Number of consecutive failed login attempts of a user into his finAPI account that is allowed before finAPI locks the user's account. When a user's account is locked, finAPI will invalidate all user's tokens and it will deny any service call in the context of this user (i.e. any call to a service using one of the user's authorization tokens, as well as the service for requesting a new token for this user). To unlock a user's account, a new password must be set for the account by the client (see the services /users/requestPasswordChange and /users/executePasswordChange). Once a new password has been set, all services will be available again for this user and the user's failed login attempts counter is reset to 0. The user's failed login attempts counter is also reset whenever a new authorization token has been successfully retrieved, or whenever the user himself changes his password.

Note that when this field has a value of 0, it means that there is no limit for user login attempts, i.e. finAPI will never lock user accounts. | **transactionImportLimitation** | **Number** | Transaction download limit in days for the ‘Import a new bank connection’ service.
'0' means there is no limitation. | [optional] **isUserAutoVerificationEnabled** | **Boolean** | Whether users that are created with this client are automatically verified on creation. If this field is set to 'false', then any user that is created with this client must first be verified with the \"Verify a user\" service before he can be authorized. If the field is 'true', then no verification is required by the client and the user can be authorized immediately after creation. | **isMandatorAdmin** | **Boolean** | Whether this client is a 'Mandator Admin'. Mandator Admins are special clients that can access the 'Mandator Administration' section of finAPI. If you do not yet have credentials for a Mandator Admin, please contact us at support@finapi.io. For further information, please refer to this article on our Dev Portal. | **isWebScrapingEnabled** | **Boolean** | Whether finAPI is allowed to use the WEB_SCRAPER interface for data download. If this field is set to 'true', then finAPI might download data from the online banking websites of banks (either in addition to other interfaces, or as the sole data source for the download). If this field is set to 'false', then finAPI will not use any web scrapers. For banks where no other interface except WEB_SCRAPER is available, finAPI will not allow any data download at all if web scraping is disabled for your client. Please contact your Sys-Admin if you want to change this setting. | **isStandalonePaymentsEnabled** | **Boolean** | Whether the finAPI Payment product is enabled for this client (doing money transfers for accounts that are not imported in finAPI). | **availableBankGroups** | **[String]** | | **products** | **[String]** | | **applicationName** | **String** | Application name. When an application name is set (e.g. \"My App\"), then finAPI's web form will display a text to the user \"Weiterleitung auf finAPI von ...\" (e.g. \"Weiterleitung auf finAPI von MyApp\"). | [optional] **finTSProductRegistrationNumber** | **String** | The FinTS product registration number. If a value is stored, this will always be 'XXXXX'. | [optional] **storeSecretsAvailableInWebForm** | **Boolean** | Whether finAPI's web form will allow the user to choose whether to store login secrets (like a PIN) in finAPI. If this field is set to false, the option will not be available and the secrets not stored. | **supportSubjectDefault** | **String** | Default value for the subject element of support emails. | [optional] **supportEmail** | **String** | Email address to sent support requests to from the web form. | [optional] **paymentsEnabled** | **Boolean** | Whether this client is allowed to do payments | ## Enum: MandatorLicenseEnum * `UNLICENSED` (value: `"UNLICENSED"`) * `UNLICENSED_WITHOUT_WEBFORM` (value: `"UNLICENSED_WITHOUT_WEBFORM"`) * `AISP` (value: `"AISP"`) * `PISP` (value: `"PISP"`) * `FULLY_LICENSED` (value: `"FULLY_LICENSED"`) * `FULLY_LICENSED_WITH_WEBFORM` (value: `"FULLY_LICENSED_WITH_WEBFORM"`) ## Enum: PreferredConsentTypeEnum * `ONETIME` (value: `"ONETIME"`) * `RECURRING` (value: `"RECURRING"`) ## Enum: [ProductsEnum] * `ACCESS` (value: `"ACCESS"`) * `DATA_INTELLIGENCE` (value: `"DATA_INTELLIGENCE"`) * `DEBITFLEX` (value: `"DEBITFLEX"`)