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.

  1. Production URL: https://onboarding.branchapp.com/?org_id={uuid}
  2. Staging URL: https://onboarding-stg.branchapp.com/?org_id={uuid}
  3. 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

  1. Add an iFrame to the HTML

    <iframe id="onboarding-widget"></iframe>
  2. Set the src to the Branch Unified Onboarding URL constructed above in one of the following ways
    1. set the src attribute directly to the iframe in HTML for less scripting

      <iframe 
      id="onboarding-widget"
      src="https://onboarding-sandbox.branchapp.com/?org_id=73dc7099-a9f3-4048-8d8a-5af7a7d04dfe">
      </iframe>
    2. set the src attribute 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;
  3. 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

  1. Pass through is_web_view=true query param
  2. If Premier Branch Wallets are enabled, add special handling to allow camera permission for step-up verification during KYC
  3. Handle deeplinking from postMessage events
  4. Provide worker with native closure option, or handle closure postMessage events to return worker to host app

postMessage Events

Event CodeDescription
accountCreated:downloadClicked to download the Branch App
accountCreated:viewViewed the page containing the Branch App download button

Example Unified Onboarding iFrame - Sandbox