Connector
Loading...
Loading...
The Quiltt Connector is an embeddable UI component that lets you access a complete, context-rich financial picture of your end-user, without writing any integration code.
The Connector is built on top of the Profile GraphQL API, and comes pre-integrated with leading bank data networks like Plaid, MX, and Akoya.
In addition to creating connections to data providers, the Connector can be configured to authenticate, enroll and redirect end-users users to create the optimal onboarding experience for your end-users.
Link to this section#How to Integrate
The Connector can be embedded and controlled in several ways; choose the approach that best fits your use-case and technology.
- HTML for the simplest web integration experience using plain HTML.
- React SDK for web integrations with React.js applications, using modern React Components and Hooks and written in TypeScript.
- React Native SDK for cross-platform integrations with React Native applications.
- Flutter SDK for cross-platform integrations with Flutter applications.
- iOS SDK for native iOS application integrations.
- Android SDK for native Android application integrations.
Additionally, a powerful JavaScript API is available for programmatic access to the Connector, such as launching, passing Session tokens, and setting up event callbacks.
Link to this section#Customize Workflow
Each Connector can be customized to create the perfect onboarding experience for your product. The following steps are generally available and can be configured in the Quiltt Dashboard.
Link to this section#Authenticate
Authenticate enables unauthenticated users to access to your Connector by signing up or signing in using an OTP code, without the need to pre-authenticate them with a Session token.
This step supports using your Connector on public websites, and is often used to streamline local development and testing.
Link to this section#Available Methods
- Email OTP: Authenticate users via a code sent to their email
- Phone OTP: Authenticate users via a code sent to their cellphone
Because Authenticate uses the Profile's email and/or phone fields to send the OTP codes, enabling Authenticate also enables the Enroll for the corresponding field if it's not already present on the Profile.
Link to this section#Enroll
Enroll allows you to securely collect Profile information from the end-user if the corresponding field is not already present on the Profile.
This information is encrypted and can be retrieved via GraphQL or the Platform API.
Link to this section#Fields
- Email: The user's email address; used byAuthenticate.
- Phone: The user's phone number; used by Authenticate.
- Name: The user's nickname or common name
- Names: The user's first and last name
- Date of Birth: The user's date of birth
- Address: The user's legal address
Link to this section#Connect
Connect allows you to create a Connections to an end-user's financial institution, repair broken connections or request new products on existing Connections.
This is where you select which Account Aggregation providers your Connector will support, and what data products you want to get access to.
Link to this section#Connect Options
- Express Mode: Skip the customizable launch screen and launch directly into the flow.
- Providers: The below aggregators can be enabled once you provision the corresponding integration.
- Products: Currently Connect supports creating Connections with the following data products:
ACCOUNT_BALANCE_REFRESHES: Access account balances.ACCOUNT_BALANCES_AND_TRANSACTIONS: Access up to 24 months of transaction history.ACCOUNT_NUMBERS: Verify account numbers to support money movement operations.ACCOUNT_OWNERS: Verify account owner information.INVESTMENTS: Access investment holdings and transactions (MX transactions coming soon).LIABILITIES: Access additional information on credit cards, student loans, and mortgages.|STATEMENTS: Access historical account PDF statements.
Once a Connection is created, you can access the currently-provisioned products using the Connection.products field in GraphQL or via Connection webhooks. To request additional products, launch a Connector in Reconnect mode by supplying the connectionId to the SDK.
Link to this section#Required vs Optional Products
If you have certain products that are required for your use-case, you should mark them as required. This will ensure that the Connector only displays institutions that support those products, providing a guarantee that a successfully created Connection will have the required product enabled.
For example, if your use-case requires ACCOUNT_BALANCE_REFRESHES and ACCOUNT_BALANCES_AND_TRANSACTIONS, you should mark both as required.
Required Products Limit the Institution List
Note that marking products as required will limit the list of institutions available to only those that support all the required products.
This means that you should only mark products as required if they are absolutely necessary for your use-case, and mark nice-to-have products as optional.
For example, a Connector with only the ACCOUNT_BALANCE_REFRESHES product as required will provide maximum institution coverage, while one configured with multiple required products will show fewer available institutions.
Additionally, depending on the provider, certain products may be automatically provisioned. For example, when connecting via MX, the ACCOUNT_BALANCES_AND_TRANSACTIONS product will automatically give you INVESTMENTS and LIABILITIES.
For information on any potential billing implications, please refer to your Quiltt agreement or contact Quiltt Support.
Link to this section#Redirect
Redirect allows you to redirect the end-user to a URL of your choice after the completion of the flow. This overrides the standard behavior of the Connector, which is to fire the exited.successful event and close. Note that this behavior is not currently supported for Mobile SDK implementations.
Redirecting revokes the current Session token, but you can configure the step to pass a new Session token to your destination URL via query param.
Note that on Mobile SDKs, this step is always ignored and the exited.successful event is always fired.
Link to this section#Redirect Options
- URL: The URL to redirect the end-user to.
- Add Session Token: Whether to append a new Session token to the URL's query params.
- Add Metadata: Whether to append ExitSuccess metadata (e.g.
profileIdandconnectionId) to the URL's query params.
Link to this section#Demo Connectors
To get a preview of different configurations, you can launch some of our demo Connectors.
Link to this section#Kitchen Sink
Link to this section#MX Account Balances and Transactions
