Authenticate Workers
Overview
If your Organization uploads the Worker's contact information along with a unique Worker ID, future API calls can be performed using the same Worker ID. This is further explained in the guide for Worker and Employee Compatibility. The Worker can be authorized to receive payments by first completing a Branch One-Time Password or an Organization App's Multi-Factor Authentication, then configuring and verifying their payment methods.
Implementation
Use the worker details from your company database to add the Worker to the Branch Organization Roster with the Create Employee API. This is the minimal information requirement to authorize a Worker for payments upon using Branch Direct to connect a personal Debit Card.
If your Organization makes ACH Credits to a Worker's Paycard for payroll instead of using the Create Disbursement API, Workers are restricted from using Branch Direct to connect a Debit Card, and must claim a Branch Wallet. In this special case, the Create Wallet API can be used with create_employee
: true
to bundle the roster upload and payment method configuration steps into one API call.
Worker authenticates using Branch App or Branch Direct Web Portal
When using Branch's existing authentication systems, the Worker will create and link a Branch Account using pre-filled contact info, which is verified using a One-Time Password to the email address or phone number.
- Branch sends the Organization an onboarding link to the Branch App or Branch Direct Web Portal
- Organization forwards the onboarding link to the Worker
- When signing up using the onboarding link, the new Branch account is linked to the previously uploaded Worker ID when the Worker inputs a matching email or phone number, which is then verified using a One-Time Password
Worker authenticates using Organization App
If your Organization embeds the Branch Direct Debit Card widget within an Organization App, the Organization becomes responsible for Application Security to authenticate and secure Worker accounts. Embedding the Debit Card widget bypasses Branch's One-Time Password system for authorizing Worker payment method changes.
After logging the Worker into the Organization App using Multi-Factor Authentication, provide the Worker links to the Branch Direct terms & privacy policy and record the agreement.
- Privacy policy: https://www.branchapp.com/legal/privacy
- Branch Direct terms: https://www.branchapp.com/legal/direct
- The Worker should check a box to agree, and this agreement should be stored in your company database
Updated about 3 hours ago