How to Configure Onboarding System Settings

If you're trying to control what happens after a candidate completes their application, you'll need to adjust your onboarding settings. These settings determine which documents and forms are assigned, how signature requests are handled, and what candidates see in their onboarding experience.

Example Case: You want to ensure new hires automatically receive the correct tax forms and policy documents after submitting their application.

Document & Task Assignment

In this section, you’ll learn how to configure document and task assignment settings, including enabling the modern onboarding request interface, allowing form previews, requiring profile completion before onboarding, and tracking required-for-hire documents to ensure critical paperwork is completed.

Map to/Key

enable_new_createbox

What it Does

Activates the modern interface for assigning onboarding forms and packages.

Use Case

Provides an improved experience for recruiters sending onboarding tasks.

This UI is required to access newer features like screening integrations and task management.

Must be enabled for all clients.

Map to/Key

enable_onboarding_form_preview

What it Does

Allows recruiters to preview a form before assigning it to a candidate.

Use Case

Ensures the correct version of a form is selected and appropriate for the candidate.

Map to/Key

complete_profile_before_onboarding

What it Does

Prevents candidates from starting onboarding tasks until they have completed their profile.

Use Case

Helps ensure complete candidate records before paperwork is issued.

Effect

Disables the “Start FormClosed Any document that needs to be completed and signed by a Candidate” button on onboarding tasks until profile completion.

Map to/Key

prompt_require_for_hire

What it Does

Flags onboarding tasks as required before a candidate can be considered fully hired.

Use Case

Ensures critical documentation (e.g., I-9s, tax forms) is completed.

This setting is not used.

eDocument Features

In this section, you’ll learn how to manage eDocument features, including automating document package assignment after application, setting signature request expirations, allowing deletion of completed eDocs, and enabling candidate file uploads for IDs, certifications, and other required documents.

Map to/Keys

What They Do

Automatically assigns a specific document package to candidates once they complete their profile.

Use Case

Streamlines compliance for clients using standard onboarding workflows.

Dependency

All fields must be configured for full functionality.

Use the Pre-hire automation instead of this setting.

Map to/Key

sig_request_expiration_days

What it Does

Defines how long candidates have to sign documents before the request expires.

Default

15 days unless otherwise configured.

Allow Deletion of Completed eDocs

Map to/Key

enable_delete_completed_edocs

What it Does

Permits administrators to delete signed documents from a candidate's profile and delete completed forms.

Use Case

For correcting errors or document management.

If enabled, admins can view and restore any document that was deleted.

Map to/Keys

  • Enable Uploads: file_uploads_enabled

  • Allowed File Types: upload_file_type

  • Image Capture Support: file_upload_image_capture_enabled

What They Do

Allows candidates to upload supplemental documents manually or via webcam/photo.

Use Case

Upload IDs, certifications, tax forms, etc.

Upload types must be defined (e.g., .pdf, .jpg).

Credential Management

In this section, you’ll learn how to enable and manage credential requests, set allowed file types for submissions, and configure credential file syncing to your ATS for streamlined compliance tracking.

Map to/Key

enable_credentials

What it Does

Enables credential request functionality.

Use Case

Collect licenses, certifications, or other compliance documents as part of onboarding.

Map to/Key

supported_credential_file_upload_types

What it Does

Defines allowed file types for credential submissions.

Map to/Key

enable_credential_file_ATS_sync_location

What it Does

Allows credential files to be synced to a specified location in your ATS.

Task Management

In this section, you’ll learn how to configure task management settings, including enabling the task list UI, allowing candidates to view completed tasks, auto-redirecting to the next task, enforcing task order, and offering self-service task assignment for flexible onboarding workflows.

Map to/Key

enable_tasks_ui

What it Does

Displays onboarding tasks in a unified task list for the candidate.

Use Case

Provides a clearer and more structured onboarding workflow.

Required for

TaskClosed A specific action that needs to be completed by a Candidate (e.g., completing a Form, Package, Credential, Skills Checklist) order enforcement, onboarding task completion rules.

This should be enabled for all clients.

Map to/Key

enable_completed_tasks_view

What it Does

Allows candidates to view and download completed onboarding tasks from their dashboard.

This should be enabled for all clients.

Map to/Key

auto_redirect_next_task

What it Does

Automatically moves the candidate to the next task upon completion of the current one.

This should be enabled for all clients.

Map to/Key

enable_enforce_task_list_order

What it Does

Requires candidates to complete onboarding tasks in the order displayed.

Map to/Key

enable_self_service_tasks

What it Does

Allows candidates to initiate tasks on their own (when applicable).

Use Case

Common with flexible onboarding or self-serve environments.

If this is enabled, a new toggle will be available on the individual form where you can determine if this form is self-service or not.

Notification Settings

In this section, you’ll learn how to enable notifications that alert candidates in real time when new onboarding tasks are assigned.

Map to/Key

enable_applicant_task_notifications

What it Does

Sends real-time notifications to candidates when new onboarding tasks are assigned.

Summary Table: Commonly Used Settings

Setting Name

Key

Description

Enable New Onboarding UI

enable_new_createbox

Activates the modern onboarding request tool

Require ProfileClosed The Applicant’s self-service ability to add or update information about themselves (e.g., job preferences, references, education, work history) Completion

complete_profile_before_onboarding

Blocks onboarding until profile is complete

Enable Auto eDocs

auto_order_edocs_enable

Automatically sends documents after application

Signature Expiration Days

sig_request_expiration_days

Defines deadline to sign documents

Enable File Uploads

file_uploads_enabled

Allows uploading files to candidate profiles

Enable CredentialClosed A record of qualification and/or clinical practices history. Example for Light Inustrial: Fork Lift Certification Example for Healthcare: Nursing License Tracking

enable_credentials

Enables credential request system

Show Onboarding Task ListClosed List of tasks that have been assigned to the Candidate and need to be completed

enable_tasks_ui

Displays a task list to candidates

Enforce Task Completion Order

enable_enforce_task_list_order

Prevents skipping or reordering tasks

Enable Task Notifications

enable_applicant_task_notifications

Notifies candidates when tasks are assigned