This guide walks you through the steps for onboarding a worker using the Branch Employee Create functionality.

For an outline of the roadmap and timing, see Get Started and the diagram below on this page.

Testing

Simulate Webhooks

You can use the Branch sandbox environment to manually trigger and test webhooks as you integrate them with your system. For details see Webhook Sandbox Testing.

Employee Create API

When a worker selects Branch as their Payment Method, your organization calls the Create Employee endpoint to create a roster record in Branch. After the roster record is created, your org surfaces a Branch deep link for workers to KYC and complete setup via the Branch app. Your org will listen for the Account Verified as Worker and Wallet Activated webhooks to determine when Branch setup is complete. Sequence of events outlined below:

All screens are subject to Branch review. View or download a PDF of onboarding screen examples with Branch-approved copy here.