Prefill Lead Data

Prefilling Lead Data for Personal Loans (Web Wrapper)

Prefill any user data you already have to reduce what the user has to type in-flow. Prefilled data is grouped into typed information objects, each passed as its own prop on the SDK component (e.g. personalInformation, loanInformation, financialInformation).

Prefilling requires a bearerToken. Pass only the fields you have — omitted fields are collected from the user in-flow.

Example

React Native

<WebWrapper
  channel="your-channel"
  zone="your-zone"
  bearerToken="{your_token}"
  productTypes={[ApiModels.ProductType.Loan]}
  personalInformation={{
    firstName: 'Bob',
    lastName: 'Dylan',
    email: '[email protected]',
    dateOfBirth: '1990-01-01', // YYYY-MM-DD
    primaryPhone: '2325624852',
    address1: '1600 Pennsylvania Avenue',
    address2: 'Apt 2',
    city: 'Washington',
    state: 'DC',
    zipcode: '20500',
    ssn: '512-54-7862',
  }}
  loanInformation={{
    purpose: ApiModels.LoanPurpose.CreditCardRefi,
    loanAmount: 7500,
  }}
  mortgageInformation={{
    propertyStatus: ApiModels.PropertyStatus.OwnWithMortgage,
  }}
  creditInformation={{
    providedCreditRating: ApiModels.ProvidedCreditRating.Good,
  }}
  financialInformation={{
    employmentStatus: ApiModels.EmploymentStatus.EmployedFullTime,
    employmentPayFrequency: ApiModels.EmploymentPayFrequency.Biweekly,
    annualIncome: 20000,
    creditCardDebt: 5000,
    bankRoutingNumber: '123456789',
    bankAccountNumber: '55555555555',
  }}
  employmentInformation={{
    directDeposit: false,
  }}
  legalInformation={{
    consentsToSms: true,
  }}
  educationInformation={{
    educationLevel: ApiModels.EducationLevel.Associate,
  }}
  onExit={(evt) => console.log('onExit', evt)}
/>

Flutter

Type Definitions

Every prop and field is optional — pass only what you have.

React Native

interface LeadPersonalInformation {
  firstName?: string;
  lastName?: string;
  email?: string;
  dateOfBirth?: string; // YYYY-MM-DD
  primaryPhone?: string; // 10 digits, no "+" or "-" chars
  address1?: string;
  address2?: string; // optional apartment / suite
  city?: string;
  state?: string; // 2-letter code, e.g. 'DC'
  zipcode?: string;
  ssn?: string; // 9 digits with or without hyphens
}

interface LeadLoanInformation {
  purpose?: ApiModels.LoanPurpose; // enum below
  loanAmount?: number; // whole numbers only
}

interface LeadMortgageInformation {
  propertyStatus?: ApiModels.PropertyStatus; // enum below
}

interface LeadCreditInformation {
  providedCreditRating?: ApiModels.ProvidedCreditRating; // enum below
}

interface LeadFinancialInformation {
  employmentStatus?: ApiModels.EmploymentStatus; // enum below
  employmentPayFrequency?: ApiModels.EmploymentPayFrequency; // enum below
  annualIncome?: number; // raw integer value (e.g. 20000)
  creditCardDebt?: number; // total credit card debt, raw integer value
  bankRoutingNumber?: string; // must be exactly 9 digits
  bankAccountNumber?: string;
}

interface LeadEmploymentInformation {
  directDeposit?: boolean;
}

interface LeadLegalInformation {
  consentsToSms?: boolean; // lead agrees to receive SMS
}

interface LeadEducationInformation {
  educationLevel?: ApiModels.EducationLevel; // enum below
}

Flutter

Enums / Accepted Values

Fields backed by an enum must use a valid value.

React Native

Use a member of the corresponding ApiModels enum (access via the ApiModels namespace, e.g. ApiModels.LoanPurpose.CreditCardRefi):

enum LoanPurpose {
  Auto = 'auto',
  AutoPurchase = 'auto_purchase',
  AutoRefinance = 'auto_refinance',
  Baby = 'baby',
  Boat = 'boat',
  Business = 'business',
  CarRepair = 'car_repair',
  Cosmetic = 'cosmetic',
  CreditCardRefi = 'credit_card_refi',
  DebtConsolidation = 'debt_consolidation',
  Emergency = 'emergency',
  Engagement = 'engagement',
  Green = 'green',
  HomeImprovement = 'home_improvement',
  HomePurchase = 'home_purchase',
  HomeRefi = 'home_refi',
  HouseholdExpenses = 'household_expenses',
  LargePurchases = 'large_purchases',
  LifeEvent = 'life_event',
  MedicalDental = 'medical_dental',
  Motorcycle = 'motorcycle',
  MovingRelocation = 'moving_relocation',
  Other = 'other',
  Rv = 'rv',
  SpecialOccasion = 'special_occasion',
  StudentLoan = 'student_loan',
  StudentLoanRefi = 'student_loan_refi',
  Taxes = 'taxes',
  Vacation = 'vacation',
  Wedding = 'wedding',
}

enum ProvidedCreditRating {
  Excellent = 'excellent',
  Good = 'good',
  Fair = 'fair',
  Poor = 'poor',
  Limited = 'limited',
}

enum PropertyStatus {
  OwnOutright = 'own_outright',
  OwnWithMortgage = 'own_with_mortgage',
  Rent = 'rent',
}

enum EducationLevel {
  HighSchool = 'high_school',
  Associate = 'associate',
  Bachelors = 'bachelors',
  Masters = 'masters',
  Doctorate = 'doctorate',
  OtherGradDegree = 'other_grad_degree',
  Certificate = 'certificate',
  DidNotGraduate = 'did_not_graduate',
  StillEnrolled = 'still_enrolled',
  Other = 'other',
}

enum EmploymentStatus {
  Employed = 'employed',
  EmployedFullTime = 'employed_full_time',
  EmployedPartTime = 'employed_part_time',
  Military = 'military',
  NotEmployed = 'not_employed',
  SelfEmployed = 'self_employed',
  Retired = 'retired',
  Other = 'other',
}

enum EmploymentPayFrequency {
  Biweekly = 'biweekly',
  Monthly = 'monthly',
  TwiceMonthly = 'twice_monthly',
  Weekly = 'weekly',
}

// state is a 2-letter US state code, e.g. 'CA', 'DC', 'NY'

Flutter

Do not prefill any fields that are empty or unavailable — omit them so the user is prompted in-flow. Prefilled data must match the type definitions above, and any field backed by an enum must use a valid value. If a value is invalid, that attribute is stripped and the user will have to enter it again manually.