Prefill Lead Data

Prefilling Lead Data for Credit Cards (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, financialInformation, creditInformation, creditCardInformation).

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

Example

<WebWrapper
  channel="your-channel"
  zone="your-zone"
  bearerToken="{your_token}"
  productTypes={[ApiModels.ProductType.CreditCard]}
  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',
  }}
  financialInformation={{
    annualIncome: 20000,
    creditCardDebt: 5000,
  }}
  creditInformation={{
    providedCreditRating: ApiModels.ProvidedCreditRating.Good,
  }}
  creditCardInformation={{
    allowAnnualFee: true,
    cardPurposes: [
      ApiModels.CardPurpose.BalanceTransfer,
      ApiModels.CardPurpose.CashBack,
    ],
  }}
  onExit={(evt) => console.log('onExit', evt)}
/>

EngineSDK(
  channel: 'your-channel',
  zone: 'your-zone',
  bearerToken: '{your_token}',
  productTypes: const [engine.ProductType.creditCard],
  personalInformation: engine.LeadPersonalInformation(
    firstName: 'Bob',
    lastName: 'Dylan',
    email: '[email protected]',
    dateOfBirth: DateTime(1990, 1, 1),
    primaryPhone: '2325624852',
    address1: '1600 Pennsylvania Avenue',
    address2: 'Apt 2',
    city: 'Washington',
    state: engine.State.DC,
    zipcode: '20500',
  ),
  financialInformation: engine.LeadFinancialInformation(
    annualIncome: 20000,
    creditCardDebt: 5000,
  ),
  creditInformation: engine.LeadCreditInformationJson(
    providedCreditRating: engine.ProvidedCreditRating.good,
  ),
  creditCardInformation: engine.LeadCreditCardInformationJson(
    allowAnnualFee: true,
    cardPurposes: const [
      engine.CardPurpose.balanceTransfer,
      engine.CardPurpose.cashBack,
    ],
  ),
  onExit: (_) {},
)

Type Definitions

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

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;
}

interface LeadFinancialInformation {
  annualIncome?: number; // raw integer value (e.g. 20000)
  creditCardDebt?: number; // total credit card debt, raw integer value
}

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

interface LeadCreditCardInformation {
  allowAnnualFee?: boolean; // whether the lead is open to cards with an annual fee
  cardPurposes?: ApiModels.CardPurpose[]; // enum below
}

class LeadPersonalInformation {
  final String? firstName;
  final String? lastName;
  final String? email;
  final DateTime? dateOfBirth;
  final String? primaryPhone; // 10 digits, no "+" or "-" chars
  final String? address1;
  final String? address2; // optional apartment / suite
  final String? city;
  final State? state; // enum, 2-letter (e.g. State.DC)
  final String? zipcode;
}

class LeadFinancialInformation {
  final int? annualIncome; // raw integer value (e.g. 20000)
  final int? creditCardDebt; // total credit card debt, raw integer value
}

class LeadCreditInformationJson {
  final ProvidedCreditRating? providedCreditRating; // enum below
}

class LeadCreditCardInformationJson {
  final bool? allowAnnualFee; // whether the lead is open to cards with an annual fee
  final List<CardPurpose>? cardPurposes; // enum below
}

Enums / Accepted Values

Fields backed by an enum must use a valid value.

Use a member of the corresponding ApiModels enum (each member maps to the on-the-wire value shown):

enum CardPurpose {
  BalanceTransfer = 'balance_transfer',
  CashBack = 'cash_back',
  EarningRewards = 'earning_rewards',
  ImproveCredit = 'improve_credit',
  LowInterest = 'low_interest',
  NewToCredit = 'new_to_credit',
  Student = 'student',
  TravelIncentives = 'travel_incentives',
}

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

// Access via the ApiModels namespace, e.g. ApiModels.CardPurpose.BalanceTransfer
// state is a 2-letter US state code, e.g. 'CA', 'DC', 'NY'

enum CardPurpose {
  balanceTransfer,
  cashBack,
  earningRewards,
  improveCredit,
  lowInterest,
  newToCredit,
  student,
  travelIncentives,
}

enum ProvidedCreditRating {
  excellent,
  good,
  fair,
  poor,
  limited,
}

// State is a 2-letter US state enum, e.g. State.CA, State.DC, State.NY

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.

PreviousCredit Cards NextClient Tags

Last updated 10 hours ago

Was this helpful?