Skip to content
KynectLocal Docs

Franchisee Onboarding Wizard

For Locations

The Franchisee Onboarding wizard runs on your first login and guides you through the four steps that matter most for local search visibility: completing your profile, reviewing your brand’s integrations, and checking your go-live readiness score.

When you’d use this

Section titled “When you’d use this”
  • You’re a franchisee logging in to a brand for the first time
  • Your brand admin has invited you and you’re getting your location set up

How the wizard works

Section titled “How the wizard works”

The wizard uses a three-layer check before deciding whether to show:

  1. Database flag — if userBrandRoles.onboarding_complete is true (returned by GET /v1/me), the wizard is skipped immediately, on any device.
  2. localStorage — if kl_onboarded_{userId}_{brandId} is set to '1', the wizard is skipped without any API call.
  3. Profile data check — if your location’s phone or addressLine1 is already populated, the wizard auto-marks complete and skips. This handles franchisees who were set up before the wizard existed.

The wizard only renders after the profile check resolves, so you won’t see a flash of the wizard followed by immediate dismissal.

Steps

Section titled “Steps”

Step 1: Welcome

Section titled “Step 1: Welcome”
Franchisee Onboarding wizard — Welcome step showing location name and checklist preview

The wizard opens with a welcome screen showing your brand name and the location you’re managing. It previews the three things you’ll do: complete your location profile, connect integrations your brand uses, and check your go-live score.

Click Let’s go to begin, or Skip to dismiss.

Step 2: Profile Basics

Section titled “Step 2: Profile Basics”
Franchisee Onboarding wizard — Profile Basics form with phone, address, city, and state fields

Enter the four fields with the biggest impact on local search visibility: phone number, address, city, and state. These save to your location profile via PUT /brands/:id/locations/:id/profile.

Click Save & continue to save and proceed, Skip to move on without saving, or Back to return to the Welcome step.

Step 3: Quick Wins

Section titled “Step 3: Quick Wins”
Franchisee Onboarding wizard — Quick Wins step showing brand integrations

This read-only step shows the integrations your brand admin has already configured — such as Calendly, HubSpot, or call tracking. These are available to your location automatically.

If your brand admin hasn’t configured any integrations yet, you’ll see a placeholder message. Click Continue to move on.

Step 4: Go Live

Section titled “Step 4: Go Live”
Franchisee Onboarding wizard — Go Live step with profile readiness score and Finish setup button

The final step shows your Profile readiness score (0–100%). Aim for at least 70% before publishing your location page. The score reflects how complete your location profile is.

Click Finish setup to mark onboarding complete and close the wizard. This sets localStorage['kl_onboarded_{userId}_{brandId}'] = '1' and calls PATCH /v1/me/brand-onboarding to persist the completion flag to the database.

Who never sees this wizard

Section titled “Who never sees this wizard”
  • Franchisees with phone or address already entered in their location profile
  • Anyone who previously completed or skipped the wizard (localStorage or database flag set)
  • Super admins (routed to the Brand Admin Dashboard)
  • Marketing-role users with existing profile data
Section titled “Related”