Worker and Employee Compatibility

Terminology

While reading through our guides and API reference, you may see the terms "Worker" and "Employee". V1 endpoints use the term "Employee". From V1 to V2, the term changed to better fit the modern workforce. V2 endpoints use the term "Worker", which will be used as the standard going forward.

Compatibility

The terms "Worker" and "Employee" both refer to the same entity. This entity is created by an Organization using an ID unique to that Organization with V1 Create Wallet or V1 Create Employee, which allows the Organization to make API calls by specifying that same ID in the future. An employee_id from V1 can be used as a worker_id in V2, and vice-versa.

Example

1. Organization 9999 onboards a new Worker in their system using a unique ID 123ABC
2. Organization tells Branch about the new Worker
   1. V1 Create Employee: POST /v1/organizations/9999/employees/123ABC
   2. This will create an Employee, which can be accessed using the same ID 123ABC as a Worker in V2 endpoints.
3. Organization makes a disbursement to the new Worker
   1. V2 Create Disbursement: POST /v2/organizations/9999/workers/123ABC/disbursements
   2. This makes a disbursement to the same Worker which was onboarded as an Employee in step 2.