Dashboard configuration

 

 

Partners who wish to access Open Banking data will be required to configure their application configuration via the basiq dashboard.

🚧

Existing partners will need to enable v3.0 via the dashboard

For existing Partners, these new tabs and configuration options for v3.0 will be greyed out and non editable by default until they enable this functionality with the toggle labeled "Enable Basiq 3.0". Once this has ben done they will be able to proceed with the new, v3.0 dashboard configuration.

Note: This only enables v3.0 access, and partners will still need to specify the version when they retrieve their auth token from the /auth endpoint.

1. Configuring your applications consent policy

By default, each application is assigned a Consent Policy when it is enabled for 3.0, but if you are creating a new application you can use the following JSON object for a template.

{
  type: 'consentPolicy',
  duration: 31536000,
  status: 'active',
  purpose: {
    primary: {
      title: 'Services requiring full ongoing Personal, Account and Transaction details',
      description: 'We need ongoing access to your Personal, Account and Transaction details in order to fully enable our services.'
    }
  },
  data: {
    retainData: true,
    permissions: [
      {
        scope: 'customer.person.detail',
        required: true,
        entity: 'connection',
        attributes: [
          'fullName',
          'occupation',
          'phone',
          'emailAddress',
          'mailAddress',
          'residentialAddress'
        ],
        information: {
          name: 'Name, occupation, contact details',
          description: 'This allows access to personally identifiable information. Specifically your name, occupation, address(es) and contact details.',
          attributeList: [
            'Name',
            'Occupation',
            'Phone',
            'Email address',
            'Mail address',
            'Residential address'
          ]
        },
        purpose: {
          title: 'Your Details',
          description: 'We need to confirm your identity.'
        }
      },
      {
        scope: 'account.basic',
        required: true,
        entity: 'account',
        information: {
          name: 'Account name, type and balance',
          description: 'This allows access to a list of your accounts and their current balance.',
          attributeList: [
            'Name of account',
            'Account number',
            'Type of account',
            'Account balance'
          ]
        },
        purpose: {
          title: 'Account name, type and balance',
          description: 'We need to capture your list of accounts.'
        }
      },
      {
        scope: 'account.detail',
        required: true,
        entity: 'account',
        attributes: [
          'name',
          'class',
          'balance',
          'accountNo',
          'interestRate',
          'fee',
          'discount',
          'accountTerm',
          'accountMailAddress'
        ],
        information: {
          name: 'Account balance and details',
          description: 'This allows access to detailed information of your accounts. It includes basic account information plus account identifiers and product information. It does not include transaction data.',
          attributeList: [
            'Name of account',
            'Type of account',
            'Account balance',
            'Account number',
            'Interest rates',
            'Fees',
            'Discounts',
            'Account terms',
            'Account mail address'
          ]
        },
        purpose: {
          title: 'Account Details',
          description: 'We need to capture your account details.'
        }
      },
      {
        scope: 'transaction.detail',
        required: true,
        entity: 'transaction',
        attributes: [
          'id',
          'amount',
          'transactionDate',
          'description',
          'merchant'
        ],
        information: {
          name: 'Transaction details',
          description: 'This allows access to transaction data for your accounts. It includes all account transaction data.',
          attributeList: [
            'Incoming and outgoing transactions',
            'Amounts',
            'Dates',
            'Descriptions of transactions',
            'Who you have sent money to and received money from'
          ]
        },
        purpose: {
          title: 'Transaction details',
          description: 'This allows access to transaction data for your accounts. It includes all account transaction data.'
        }
      }
    ]
  }
}

 

 
When uploading your updated version of the JSON, you should keep in mind the rules and requirements as proposed by the CDR, and defined within the latest CX Guidelines.

How this dictates the consent UI

The Basiq Consent UI will dynamically display values, and requests data sets based on the uploaded JSON schema.

 

 

Config

displayName

Landing page and throughout the flow

institutions

Filters the list of institutions (Select your bank)

logo

Image displayed in the header

redirect

Link used to navigate back to partner application once flow is completed (or when close button is pressed).

duration

Visible on the confirmation screen

purpose

Title values shown in 'This will be used to' section, title and description shown in popup window

permissions

Purpose title shown under ‘Data we need to collect’ section, with name, description and attributeList shown in popup

disclosure

Shown in "Your data is Secure section" under "We may share your data with..." title

 

2. Configuring your available institutions

As Open Banking becomes more widely adopted, the number of available institutions will increase, and in some cases there may be multiple ways to connect to a single institution - such as ING Open Banking and ING Digital Data Capture.

 
Using the Institutions section of the dashboard, partners can configure which institutions they would like to present to their end users. Note: The application dashboard Institution picker will only show Open Banking data sources for institutions if the partner is enabled. See enablement for more information.

E.g. Partners may choose to exclude any that specifically relate to business banking as they are irrelevant for their use case, or to only have Open Banking supported institutions available.

🚧

This configuration does not impact the institutions endpoint

Configuring your applications institutions through the dashboard will only determine which institutions are displayed to your end users when using the Consent UI. The institutions endpoint is a separate entity and will behave as normal regardless of what is selected here - it will always display the full list of offered institutions.

 

3. Configuring your data governance web hook Coming soon.....

Basiq will monitor for triggered actions in a user's consent. Partners will need will need to provide a web hook for Basiq to use to alert them when any of these events occur.

Partners can do this by adding the webhook to their application dashboard.

See here for more information on data governance with open banking including what's coming up.


Did this page help you?