Unified Onboarding
Overview
With powerful query parameters for streamlining the worker onboarding process and right-sizing into any integration, Unified Onboarding is the standard offering from Branch.
Implementation
URL Format
Construct the Branch Unified Onboarding URL for the intended environment using the Organization's UUID and optional query parameters to streamline the process. This URL can be directly provided to Workers.
- Production URL: https://onboarding.branchapp.com/?org_id={uuid}
- Staging URL: https://onboarding-stg.branchapp.com/?org_id={uuid}
- Sandbox URL: https://onboarding-sandbox.branchapp.com/?org_id={uuid}
Required Query Params:
org_id
- Definition: Providing the Organization's UUID configures the onboarding process using your Organization's settings and links new Workers to your Organization's roster
- UUID has format:
XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Optional Query Params:
worker_id
- Definition: Providing the Worker ID as a query param will allow the user to bypass the worker search step (entering phone and email)
- Use Case: Onboarding links are emailed to individual workers, or the worker is accessing their onboarding link through a partner app where they are authenticated
JavaScript Web Implementation
-
Add an iFrame to the HTML
<iframe id="onboarding-widget"></iframe> - Set the
srcto the Branch Unified Onboarding URL constructed above in one of the following ways-
set the
srcattribute directly to theiframein HTML for less scripting<iframe id="onboarding-widget" src="https://onboarding-sandbox.branchapp.com/?org_id=73dc7099-a9f3-4048-8d8a-5af7a7d04dfe"> </iframe> -
set the
srcattribute using JavaScript for dynamic configuration// The URL below is for the Branch Sandbox, choose the production, staging, or sandbox URL accordingly var iFrameURL = "https://onboarding-sandbox.branchapp.com/?org_id=73dc7099-a9f3-4048-8d8a-5af7a7d04dfe"; document.getElementById("signup-widget").src = iFrameURL;
-
-
If Premier Branch Wallets are enabled, add special handling to allow camera permission for step-up verification during KYC
<iframe id="onboarding-widget" allow="camera"></iframe>
iOS Swift WebView Implementation
- Pass through
is_web_view=truequery param - If Premier Branch Wallets are enabled, add special handling to allow camera permission for step-up verification during KYC
- Handle deeplinking from
postMessageevents - Provide worker with native closure option, or handle closure
postMessageevents to return worker to host app
postMessage Events
| Event Code | Description |
|---|---|
| accountCreated:download | Clicked to download the Branch App |
| accountCreated:view | Viewed the page containing the Branch App download button |
Example Unified Onboarding iFrame - Sandbox
Updated 12 months ago
