White label Business Onboarding with iframe & Prefill

Written By Anand Raj

Last updated 13 days ago

This integration is built for Agencies that already have Business records in their own CRM, dialer or back-office tool, and want to onboard those existing Businesses into Kickcall without making them retype the same details. It pre-fills the Stage 1 form via URL parameters — so the Business only has to review and confirm — and works either in a new tab or embedded as an iframe inside the Agency's own interface.

Base URL

Stage 1 onboarding always lives at:

https://{your-agency-domain}/business-onboarding/stage-1

Replace {your-agency-domain} with the Agency's whitelabel custom domain configured in Configuration → General → Branding.

Query parameters

Parameter names are case-sensitive — use the exact names below.

Query parameter

Required

Description

Email-Address

Yes

Primary contact email. Must be unique — one onboarding per email.

Phone-Number

Yes

Primary contact phone. Must be unique — one onboarding per phone.

External-Reference-Name

Yes

Human-readable label from the Agency's CRM (e.g. company name). Does not need to be unique.

External-Reference-Id

Yes

Unique ID of that account in the Agency's CRM.

External-Reference-Source

Yes

CRM or system identifier. Any value works — e.g. asterisk, skyswitch, netsapiens. Coordinate with Kickcall before going live.

First-Name

No

Contact first name.

Last-Name

No

Contact last name.

Company-Name

No

Business legal name pre-filled on the form.

Values with spaces or special characters (+ & # % etc.) must be URL-encoded — e.g. user@example.com becomes Email-Address=user%40example.com.

Example URLs

With optional name and company:

https://{your-agency-domain}/business-onboarding/stage-1?First-Name=gaurav&Last-Name=gupta&Email-Address=gaurav555%40gmail.com&Phone-Number=8702323232328&Company-Name=toyota&External-Reference-Name=TechCorp&External-Reference-Id=TechCorp_16ed42fa-a4bb-4ccb-b7a2-5f05d7&External-Reference-Source=asterisk

Required parameters only:

https://{your-agency-domain}/business-onboarding/stage-1?Email-Address=gaurav555%40gmail.com&Phone-Number=8702323232328&External-Reference-Name=TechCorp&External-Reference-Id=TechCorp_16ed42fa-a4bb-4ccb-b7a2-5f05d7&External-Reference-Source=asterisk

Note: The system performs searches based on (1) the combination of email and phone number, or (2) the external reference ID. If any of these details are available in the URL, the system will continue to use the existing form.

Embedding as an iframe

<iframe 
src="https://{your-agency-domain}/business-onboarding/stage-1?Email-Address=...&Phone-Number=...&External-Reference-Name=...&External-Reference-Id=...&External-Reference-Source=asterisk" 
width="100%" 
height="900" 
style="border: 0;" 
allow="clipboard-write; payment" 
></iframe>

Frequently Asked Questions

More in Onboarding