Skip to content
Item Detail
Mass Initiation of Onboarding via API
General Availability Info Only Automatically On Impact: Medium AI Enriched
Description

You can now onboard multiple candidates at once using the Mass Initiate Onboarding REST API. See More

Detailed Description

The Mass Initiate Onboarding REST API enables organizations to onboard multiple candidates simultaneously, including new hires and rehires on new employment. Beyond mass initiation, the API creates onboarding journeys for external users by assigning relevant tasks and supports mass cancellation of onboarding processes. The API implements partial success capability, isolating failures to specific transactions while allowing the overall bulk process to continue.

Impact Assessment

This feature provides organizations with flexibility and scalability to manage complex onboarding scenarios during acquisitions, mergers, rehires, and restructuring with minimal manual intervention. The partial success capability ensures that failures in individual onboarding requests do not impact the overall bulk process, improving reliability. Implementation requires enabling specific role-based permissions including Manage Onboarding or Offboarding, Initiate Onboarding API, Manage Hires, and related permissions for rehires and cancellations.

Test Recommendations
• Test mass initiation of onboarding for new hires using the Mass Initiate Onboarding REST API • Test mass initiation of onboarding for rehires on new employment • Verify that onboarding journeys are created for external users with relevant tasks assigned • Test mass cancellation of onboarding processes • Validate partial success scenarios by initiating bulk requests with mixed valid and invalid records, confirming that failures remain isolated to specific transactions • Verify that response payloads correctly indicate the status of each record showing which succeeded and which encountered issues • Confirm that all required role-based permissions are properly configured before testing
Product: Onboarding
Modules: Onboarding
Feature: Onboarding
Reference: OBX-30554
Version: 1H 2025
Valid as Of: May 16, 2025
Latest Revision: May 16, 2025
Affected Areas:
Onboarding Offboarding Hire to Retire API Integration User Management Role-Based Permissions External User Management Bulk Operations