Enablement
Embedding the VIDA App via Iframe
Guide for partners to integrate the VIDA application into their websites using an iframe.
Partners can surface the full VIDA app inside their own domain with a single <iframe>
. This enables secure auto-login, identity verification, and flexible signup flows without any custom backend work.
Embedding Overview
With the iframe embed you can:
- Auto-login users via a one-time
authToken
. - Verify user identity with the
email
parameter. - Redirect unauthenticated visitors into signup.
- Pre-fill signup fields (business name, full name, contact number).
- Customize messaging via the
custom
flag.
Example Embed Code
Required parameters
authToken
– one‑time authentication token used by the embed page to log the user in automatically. If omitted, the page logs the user out before rendering. Read this page to learn how to get a one time authToken.email
– the email that must match the authenticated user. If it does not match, the user is logged out. When the email changes, the user will be automtically logged out.
Optional parameters
signup
– when present and the user is not authenticated, the embed redirects to the sign‑up flow.customerId
– external customer identifier passed through to the sign‑up page.businessName
– pre‑fill the business name on sign up.fullName
– pre‑fill the user’s name on sign up.contactNumber
– pre‑fill the phone number on sign up.custom
– allows alternate sign‑up messaging such asansweringservice
orcreateagent
.
Any combination of optional parameters may be included after the required authToken
and email
.
Summary
This guide explains how partners can embed the VIDA application on their own sites using a simple <iframe>
integration. It covers the two required query parameters—authToken and email—for automatic user authentication and outlines several optional parameters to customize signup flows and pre-populate user data.