engine_mobile_flutter_sdk 0.0.2
engine_mobile_flutter_sdk: ^0.0.2 copied to clipboard
Flutter SDK for Engine by MoneyLion. Provides turnkey marketplace flows for Personal Loans, Credit Cards, and more.
Engine Flutter SDK #
Flutter SDK for Engine by MoneyLion. Provides turnkey marketplace flows for Personal Loans, Credit Cards, Deposits, Auto Insurance, and Thin Vertical marketplaces.
Features #
- 🚀 Quick Integration - Add marketplace flows to your Flutter app in minutes
- 📝 2nd Party Prefill - Pre-populate user data to reduce form friction
- 📊 Event Callbacks - Track user actions for analytics and flow control
- 🎨 Configurable UI - Customize splash screen, navigation bar, and branding
- 🔒 Secure - PII handled via secure server-to-server API, never exposed in client
Getting Started #
Prerequisites #
- Flutter 3.0.0 or higher
- Dart 3.10.7 or higher
- Engine API key (Get one here)
Installation #
Add to your pubspec.yaml:
dependencies:
engine_mobile_flutter_sdk: ^0.0.1
Then run:
flutter pub get
Prefill Data Fields #
All fields on LeadPrefillData are optional. Pass only what you have.
LeadPrefillData #
| Field | Type | Description |
|---|---|---|
| firstName | String? | First name |
| lastName | String? | Last name |
| dob | String? | Date of birth |
| annualIncome | String? | Annual income |
| phoneNumber | int? | Phone number |
| creditRating | String? | Credit rating |
| ssn | String? | Social Security Number |
| loanPurpose | String? | Loan purpose |
| loanAmount | int? | Requested loan amount |
| propertyStatus | String? | Property status (e.g. own, rent) |
| employmentStatus | String? | Employment status |
| payFrequency | String? | Pay frequency |
| fcraConsent | bool? | FCRA consent |
| tcpaConsent | bool? | TCPA consent |
| address | Address? | Full address (see below) |
Address #
When providing address, all fields except addressLine2 are required.
| Field | Type | Description |
|---|---|---|
| addressLine1 | String | Street address line 1 |
| addressLine2 | String? | Street address line 2 (optional) |
| city | String | City |
| state | String | State |
| zip | String | ZIP code |
Event Callbacks #
| Event | Description |
|---|---|
| onInitialize | Called when the SDK initializes |
| onCreate | Called when a new lead is created |
| onUpdate | Called when a lead is updated |
| onNavigate | Called when user navigates between pages |
| onSubmit | Called when the flow is submitted |
| onRateTableRender | Called when offers are displayed |
| onOfferClick | Called when an offer is selected |
| onExit | Called when user exits the flow |
| onError | Called when an error occurs |
Development #
Setup #
cd flutter_wrapper
flutter pub get
Git Hooks (Lefthook) #
This project uses Lefthook for pre-commit and pre-push checks.
# Install lefthook (if not already installed)
brew install lefthook
# Install git hooks (run from repo root)
cd ..
lefthook install
Once installed, flutter analyze will run automatically:
- Pre-commit: Before each commit on changed
.dartfiles - Pre-push: Before each push on changed
.dartfiles
Run Linting #
flutter analyze
Run Tests #
flutter test