Include the IXily Link initialize script on each page of your site. It should always be loaded directly from https://ixily.io, rather than included in a bundle or hosted yourself.
To initialize, add your credentials:
The setting of this value will determine whether demo or production accounts will be linked. Different investment account providers do have different workflow, but the intention is that if the environment is set to Demo, only demo/test/paper accounts can be added. When set to Production, if the configuration of the Collection allows for it, a demo account can be linked (to that collection).
The text used within the SDK is available in multiple languages, however the text of the Collection shows in whatever language was used in its configuration.
There are two types of user - hybrid and partner.
Note that if 'hybrid' is selected, the user will be required to authenticate, register or have a bearer token passed in. While it might seem easier to set all users to 'partner', the user's experience and ability to own, control and customise their data and interact with a service will be extremely limited if this is the case. While 'hybrid' does add an authentication layer, it will enable the user to link their account within the context of their financial network, rather than for just a single party.
If the 'user' is set to 'partner' then an object of the user's details can be passed in for your own reference. None of these values are required and none are required to be 'real'. The purpose is associate some basic information with your internal user and the user record created at IXily.
If a bearer token is available, it can be passed to the SDK in order to identify the authenticated user. This will be most commonly used when you have authenticated as yourself. A token should only be passed where the User Type has been set to 'hybrid'.
If you as a client have another way to accept/take payment then you must set this property to false otherwise the payment subscriptions will be enabled.
The level of access that is required on the end user's investment account. Note that only one party can have s (execution) access to the account at any one time.
If after finishing a process you want to save or only show the result on your site, whether successful or not, you can use this function:
The account owner can be directed to any number of points within the linking workflow to begin the process. Where they will be begin will depend on not only the service you want to provide, but if you want the user to see all your services/products, how you want to charge for your service and how simple you want the workflow to be.
Services are those financial products which you or your company provides such as account management, advisory, trade ideas, descretionary management and more. An end user will select a service to view those products that you offer within the service.
A collection is a group (of accounts). In the context of linking this is typically where the collection is used for Execution or Discretionary management i.e. each collection is a fund/strategy (to which the user will link their account). If you offer a number of funds/strategies then the SDK can be configured to open at the list of these funds/strategies.
View the details of an individual collection including any supported business models (payments) and entry requirements such as minimum/maximum account balance, account types, investor type restrictions (retail vs accredited/professional).
Initiates the linking process of an account to a collection (for read or write), but bypasses the introductory view. This is may be preferential where the linking context has already been provided to the user in a site/app and the priority is the linking process only.
For an authenticated user, investment accounts that the user has previously linked can be displayed to allow easier transparency during to the linking process as to what account they have already linked, with who and with what permissions. It may particularly help where the Requested Scope is for read access which can be granted on accounts that have already been linked (for each or s access). This means that the user has already connected their account securely and will not be required to do so again.
Verification of user identity; in the context of account linking, a collection can be configured to require the connecting user to be KYC'd before the linking process can be initiated. For example, any invest manager would require their clients to be KYC.
Professional status is currently limited to the United Kingdom. Based on the FCA's criteria for what constitutes a Professional investor, a user can connnect both bank and brokerage accounts to determine if their level of cash trading experience.
Option to add information related to user billing.