Skip to main content

iCIMS Integration Guide for CRAs

Sydney Harper avatar
Written by Sydney Harper
Updated over a week ago

Overview

The iCIMS integration allows background check orders to be initiated directly from iCIMS and results/statuses to be returned back to iCIMS. The integration is triggered by a workflow status change in iCIMS.

Important: This is a fixed integration. deverus does not offer custom changes for iCIMS beyond the configuration options described in this guide.

Timeline

Most iCIMS integrations can be completed in ~2–4 weeks once credentials and required decisions are available. iCIMS Professional Services timelines may vary depending on their internal scheduling.

Integration Connection Pricing

1. Self-Service Integration (No Cost): Clients or their representatives, including iCIMS consultants, can independently set up iCIMS integrations without incurring additional charges.

We continue to provide comprehensive resources for self-implementation:

  • Detailed integration documentation

  • Step-by-step implementation guides

  • Access to our knowledge base

These resources remain completely free and are sufficient for most standard integration scenarios.

2. Premium 14-Day Support Package ($2,250): During this period, clients can benefit from unlimited support from deverus for addressing integration concerns and implementing assistance.

For situations requiring direct assistance from our team, we offer a 14-day support package:

  • Direct access to our integration specialists

  • Technical troubleshooting and guidance

  • Implementation assistance

  • Configuration help

  • Testing support

Client Decision Required: Results URL Access

The client must choose how users will open completed background check results from iCIMS:

  • Link With Login: Requires deverus credentials to view the report.

  • Link Without Login: Does not require login; the link expires after a set time.

If Link Without Login is selected, confirm the expiration:

  • 1 week

  • 2 weeks

  • 30 / 60 / 90 / 180 / 365 days

Integration Requirements

Prerequisites for Setup

  • Client has an existing iCIMS instance

  • SwiftHire Mobile is required

deverus Platform Requirements

  • SwiftHire settings configured (recommended at client-type level) and applied to user profiles

  • Active default user at client level(s)

  • Active package(s) (recommended at client-type level)

  • If multiple locations: Branch Administration enabled at the primary branch and locations nested appropriately

Required Information for Setup

iCIMS provides

  • Customer ID

  • API credentials (API Username + Password)

CRA / deverus provides

  • Integration URL (copy from Integration Manager after the account is created)

  • API Private Key (copy from Integration Manager; used for Basic Auth as both username and password)

  • IP addresses for whitelisting (see below)

  • Package Names and Package IDs in deverus

  • ClientID(s) which will be the Billing Code value(s) in iCIMS used for location mapping

Field Mappings (iCIMS Job Detail tab)

Required Job Detail fields

The integration uses the following iCIMS Job Detail fields:

  • BGCheck Package (API ID: bgcpackagetype)

  • Billing Code (API ID: billingcode)

Field Name Mappings (used in Integration Manager)

  • PackageId Field Name Mapping: job.bgcpackagetype[0].value

  • LocationId Field Name Mapping: job.billingcode[0].value

IP Allowlist (Whitelist)

Provide the following IP addresses to iCIMS for whitelisting:

52.0.224.177
52.20.4.99
52.6.212.205
52.7.231.178
52.7.11.86
52.5.200.200
52.10.226.222
52.11.157.248
52.32.152.7
52.205.36.114
52.205.36.185
174.82.68.74
45.31.183.71
52.204.170.112
34.235.238.21
52.55.202.87

Project Steps

  1. Kickoff call (iCIMS)
    iCIMS assigns an Integration Consultant and confirms stakeholders and timelines.

  2. Confirm required decisions
    End client confirms:

    • workflow status trigger in iCIMS

    • results URL access format (Link With Login vs Link Without Login + expiration)

  3. Exchange credentials and technical details

    • iCIMS sends: Customer ID + API credentials

    • CRA/deverus sends: Integration URL + API Private Key (copied from Integration Manager) + allowlist IPs

  4. Configure Integration Manager (IM) (CRA or deverus Integration Team)
    Follow the steps in the next section.

  5. Testing (roundtrip)
    Trigger a test order from iCIMS and verify:

    • order triggers from the intended workflow status change

    • statuses/results return to iCIMS (Screen tab)

  6. Go-live
    After a successful test roundtrip, the integration can be used in production.

Integration Manager (IM) Configuration Steps

These steps are completed by either the CRA (Self-Service) or the deverus Integration Team (Premium Support).

  1. Login to deverus -> Integration tab -> Home

  2. Select the iCIMS tile

  3. Choose Configure Existing Client

  4. Type in the name of the top/parent client account and select it

  5. Choose the Send Results option:

    • Report Link with Login (the result URL in iCIMS for the completed report will prompt the user to enter their deverus login credentials to view report)

    • Report Link without Login (the result URL in iCIMS for the completed report will bring the user directly to a copy of the report)

  6. Toggle "Use SwiftHire" to On

  7. Enter the required client details:

    • Customer ID (from iCIMS)

    • Customer Name (client name as it should appear in IM)

    • API Username (from iCIMS)

    • API Password (from iCIMS)

    • PackageId Field Name Mapping (copy exactly as follows): job.bgcpackagetype[0].value

    • LocationId Field Name Mapping (copy exactly as follows): job.billingcode[0].value

    • Person Fields (copy exactly as follows): firstname,middlename,lastname,usssn,birthdate,email,addresses,phones,education,workexperience,drivinglicensestate,drivinglicensenumber,references

    • Job Fields (copy exactly as follows): bgcpackagetype,jobtitle,recruiter,drugscreenpackage,billingcode,joblocation

  8. Click 'Save'

  9. Copy the Integration URL and API Private Key (send to the iCIMS consultant)

    • Locate the account you just created in Integration Manager

    • Go to Settings → Credentials

    • Select Show Private Credentials

    • Copy and provide the following to the iCIMS Integration Consultant:

      • Integration URL

      • API Private Key

    * Use the copy buttons next to each value to ensure credentials are copied exactly.

  10. Map Package(s)

    • Locate the account you just configured in IM

    • Navigate to "Map Fields"

    • Enter the appropriate package value in to the Integrations Partner Package ID field (iCIMS will use the deverus packageID for this)

    • Save Mappings

  11. Map Location(s)

    • Locate the account you just configured in IM

    • Navigate to "Map Fields"

    • Enter clientID in the Integrations Partner Location ID field

    • Save Mappings

  12. Test the Integration

    • Have the consultant submit a test order and verify status updates

    • Ensure applicant statuses (In Progress Candidate, In Progress Vendor, Complete) flow correctly between iCIMS and deverus

    • Once a full roundtrip test is successful, the integration is ready to use in production.

Related Articles
UKG Pro (UltiPro) Integration Guide for CRAs
Workday Integration Guide for CRAs
Greenhouse Integration Guide for CRAs
UKG Ready (Kronos) Full Integration Guide for CRAs
SuccessFactors Integration Guide for CRAs
Did this answer your question?