Onboarding Workflow Data Model

The table below describes the different standard field types available and their representation when retrieving their values as well as the expected representations when modifying them.

Notes:

• Child fields are listed below their Parent field, indicated by an em dash (e.g., "— addresscity").

• Click the red plus sign to the right of each row to view a field's options, if applicable.

• For information on fields required for successful imports, please see the "Missing Required Columns" section of the What Might Cause My Import to Fail? under Imports on the File-Based Transfers page.

• Click here to download an Excel file containing the information below.

Manipulating the Onboarding Workflow Using the API

Onboarding Workflows can be created and updated using the Profiles API. The endpoint for the Onboarding Workflow is as follows:

https://api.icims.com/customers/{customerId}/onboardworkflows/{onboardworkflowId}