Skip to main content

AppScreen

The AppScreen is the interactive application you should redirect the end-user to start the flow of providing the necessary consents of the bank accounts for the end-user.

To initiate an end-user to start the flow, direct the end-user to the link below. You can include any of the following parameters in the URL. The last four, regarding access permissions to the bank data, are enforced differently per bank, i.e. some banks allow all of them while others do not (see Providers page). When not applicable, the defaults apply.

https://app.staging.enablenow.nl/

Use the following request parameters:

Parameter
Required
Description
client
Yes
Your client ID.
redirect_uri
Yes
The page the end-user is redirected to after completing the flow.
sync_mode
No (default full)
Defines the way EnableNow handles the retrieving of account information after a consent is given, read the details of Consent Sync Mode options on the Consent Sync Mode Documentation.
user_id
No
User ID (from pre-created user), used for User-based access. Use this or the external_user_id. Not used on Consent-based access.
external_user_id
No
Own unique external user ID (from pre-created user), used for User-based access. Use this or the user_id. Not used on Consent-based access.
provider
No
This parameter selects a bank automatically in the AppScreen. Currently supported banks are shown on the providers page. Use one of the ProviderKey values as this parameter value.
log_level
No
This parameter can be used when debugging consent issues. This can only be used when EnableNow support requested you to use this parameter. Currently supported values are:
  • debug
  • trace
consent_duration
No
Allows a custom consent expire date. Accepts an integer value between 1 and 180 days (default).
recurring_access
No
If true, consent data can be fetched multiple times (default) otherwise consent data can only be accessed once.
access_balances
No
If true, access to balance information is granted (default) otherwise balance information will not be available.
access_transactions
No
If true, access to transaction information is granted (default) otherwise transaction information will not be available.

All parameter values should be URL Encoded in the query string.

Redirect URI​

The redirect URI's can be specified in the app settings using the Management Portal.
A redirect URI can be any http URI or an app specific callback URL like: myapp://callback.

A couple examples of the resulting link with some request parameters:

with redirect_uri:
https://app.staging.enablenow.nl/?client=123456789&redirect_uri=https%3A%2F%2Fwww.enablenow.nl%2Fredirect%3Fexternal_user_id%3Duser-a

with redirect_uri, consent_duration and recurring_access:
https://app.staging.enablenow.nl/?client=123456789&redirect_uri=https%3A%2F%2Fwww.enablenow.nl%2Fredirect%3Fexternal_user_id%3Duser-a&consent_duration=1&recurring_access=false

with redirect_uri, access_balances and access_transactions:
https://app.staging.enablenow.nl/?client=123456789&redirect_uri=https%3A%2F%2Fwww.enablenow.nl%2Fredirect%3Fexternal_user_id%3Duser-a&access_balances=false&access_transactions=false

Extra redirect URI parameters​

Extra query string parameters in the redirect URI are ignored and just forwarded back when redirecting back to user. It is not neccessary to add these query strings in the redirect URI in the Customer Portal.

Response parameters​

When the end-user finishes the flow, the end-user is redirected to the redirect_uri with the following parameters:

Parameter
Required
Description
consent_id
Yes
A unique value used to identify this consent result.

External users​

When using the user_id or external_user_id parameter to start a User-based access flow in the AppScreen, be sure to supply the correct user_id or external_user_id to the AppScreen. If an existing user_id or external_user_id is passed in, the consents will be linked to the existing user and the current consents for the selected accounts will be invalidated. See the invalidating data section for more information.

danger

Do not use incremental values or values which can be easily guessed as external_user_id.
Do not use e-mail addresses or other privacy related data as external_user_id.

In that situation it is recommended to generate a random external_user_id when creating a user and use the generated user_id of EnableNow when calling the AppScreen to prevent users to overwrite consents of other users.

Embedding​

The EnableNow AppScreens are not able to be embedded or displayed within an <iframe>, <frame>, <embed> or <object> HTML elements.