Employee Create
Onboard Workers with the Create Employee method
This guide walks you through the steps for uploading roster information to allow a new Worker to verify with your Organization, using the Create Employee API.
Create Employee 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:
Webhooks
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.
Webhook Events
Wallet webhook events are sent asynchronous to notify on updates to wallet status. Below we provide information about webhooks related to Worker activation. For more details about webhooks see the Webhook Reference Docs
Event | Description | Suggested Action |
|---|---|---|
| ACCOUNT_VERIFIED_AS_WORKER | The worker has entered contact information that matches the uploaded Roster, and verified using One-Time Password | Mark Worker as allowed to start employment and accruing wages |
| PAYMENT_PROFILE_ACTIVATED | User has completed linking of a personal Debit Card or activation of a Branch Wallet | Mark Worker as fundable in payroll system |
| WALLET_ACTIVATED | User has passed Fraud checks and wallet is ready to be claimed by user | Log event for troubleshooting Perform any account updates necessary for user notification and/or customer support. Share |
Updated 29 days ago