Skip to main content

SuccessFactors Integration Guide for CRAs

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

Overview

The SuccessFactors integration with deverus allows seamless background check processing directly from SAP SuccessFactors. For SuccessFactors projects, the client’s SuccessFactors administrator or consultant is always responsible for configuring SuccessFactors itself (custom fields, statuses, permissions, IP allowlisting, etc.). deverus does not act as a general SuccessFactors implementation partner—we provide the requirements and behavior for our integration.


Timeline

Estimated Time to Configure

  • Configuration by Client (SuccessFactors side):
    Varies based on the client’s familiarity with SuccessFactors and internal approvals.

  • IM Account Configuration by CRA:
    Typically 1–2 business days after all required credentials and details are received from the client.

  • Configuration by deverus (premium support):
    Approximately 2 weeks total (includes IM configuration and coordination with the client).

Expected Go-Live Timeline

Once all requirements are met (client-side configuration complete, IM configured, and at least one successful roundtrip test), the typical go-live time is about 2 weeks, including testing and validation.


Integration Connection Pricing

1. Self-Service Integration (No Cost)

For self-service implementations, we provide the resources and you (and your client) do the configuration:

  • Detailed integration documentation

  • Step-by-step implementation guides

  • Access to our knowledge base and support portal

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

2. Premium 14-Day Support Package ($2,250)

For CRAs and clients who want more hands-on help, we offer a 14-day support package:

  • Direct access to deverus integration specialists

  • Technical troubleshooting and guidance

  • Assistance with IM configuration and mapping

  • Support through testing and initial go-live

This package is optional but recommended if the client does not have a strong internal SuccessFactors or IT resource.


Integration Requirements

Prerequisites for Setup

  • Partnership with SAP / SuccessFactors:
    Not required, to our knowledge.

  • SuccessFactors Consultant Required:
    Not required, but strongly recommended, especially if the client has limited internal SF expertise.

  • deverus / CRA responsibilities:

    • deverus Integration Manager (IM) configuration – completed by the CRA, or by deverus under a separate SOW / the premium support package.

    • Client-side SuccessFactors configuration – always completed by the client and/or their consultant.

  • SwiftHire Mobile:
    Optional but recommended if candidate-facing data and consent collection is preferred.

    • If the client uses SwiftHire, candidate completes data and consent via SwiftHire.

    • If the client does not use SwiftHire, required applicant data (SSN, DOB, DL, etc.) must already exist in SuccessFactors and be passed via the integration.

  • Network / Security:

    • The client’s network/security team may need to allowlist deverus integration IP addresses so our integration service can reach their SuccessFactors OData endpoint.

    • The current list of IPs is provided in the attached “deverus Integration IP Addresses” document.

The client’s SuccessFactors team is responsible for configuring their environment using the attached:

  • Configuration Guide for SuccessFactors Administrators

  • Recruiter Workflow Guide for SuccessFactors × deverus Integration

  • (Optional) Technical Overview for SuccessFactors × deverus Integration (for their IT team)


Required Information for Setup

Before configuring Integration Manager, you’ll need the following from your client (or pass it along to deverus Integration Specialist).

SuccessFactors Connection Details

  • Company ID (Customer ID)

  • API username (technical user for OData)

  • API password

  • SuccessFactors OData API endpoint URL (for example, https://<tenant>.successfactors.com/odata/v2/)

  • Confirmation from the client’s side that the deverus integration IP addresses (listed in the attached “deverus Integration IP Addresses” document) have been allowlisted for access to their SuccessFactors OData endpoint.

Status & Field Configuration Details

From the client’s SuccessFactors admin/consultant:

  • Confirmation that the required JobApplication custom fields have been created and added to the correct Job Application template(s), including:

    • Background Package (CUST_bgPackage picklist)

    • Status/result/report fields (CUST_bgOrderStatus, CUST_bgResultStatus, CUST_bgOrderDate, CUST_bgSummary, CUST_bgReport)

  • The list of Application Statuses used for background checks, including at least:

    • Background Verification Initiated

    • Background Verification In Process

    • Background Verification Complete

    • Background Verification On Hold

    • Background Verification Failed

  • The internal IDs for those statuses (from the SuccessFactors backend).

Package & Location Details

  • The list of background check packages that should be available in SuccessFactors (matching what you have set up in deverus).

  • The list of locations / branches / divisions (if you plan to map SuccessFactors locations to deverus locations).

State Configuration

  • Confirmation that state fields (address, education, employment) in SuccessFactors use two-letter state abbreviations (e.g., TX, CA).

Tip: Provide the three SuccessFactors documents to the client early. Most of the information above will fall out naturally as they follow the Configuration Guide.


Project Steps

1. Share the SuccessFactors Guides with the Client

Provide your client with:

  • SuccessFactors Configuration Guide (Admins)

  • SuccessFactors Recruiter Workflow Guide

  • SuccessFactors Technical Overview (optional, for IT)

2. Client Configures SuccessFactors

The client (or their SuccessFactors consultant):

  • Sets up required custom fields, statuses, permissions, and state codes following the Configuration Guide.

  • Performs any internal checks or validation they need.

deverus does not configure SuccessFactors directly, but can review and advise as part of the premium support package.

3. Collect Required Details from the Client

From the client, gather:

  • Credentials (Company ID, API username/password, OData endpoint URL).

  • Status names and internal IDs.

  • Confirmation of required JobApplication custom fields and the package picklist.

  • Package and location lists.

4. Configure the Account in Integration Manager (IM)

The CRA integration team (or deverus, if engaged) sets up the SuccessFactors connection and mapping in IM using the collected details.

5. Perform Roundtrip Testing

  • Client submits a test candidate from SuccessFactors.

  • You and the client verify that the order, statuses, and result fields behave as expected.

6. Go Live

After successful testing and sign-off, the integration is ready for production use.


Integration Manager (IM) Configuration Steps

Steps for CRA or deverus Integration Team

Important: Wait to configure IM until you have all required information from the client (see “Required Information for Setup”).

1. Log in to deverus

  • Navigate to the Integration tab → Home.

2. Select the SuccessFactors Integration

  • Click the SuccessFactors tile.

  • Choose Configure Existing Client.

  • Search for and select the top/parent client account.

3. Choose Result Delivery Option

Select how the client wants SuccessFactors users to access their reports:

  • Report Link with Login

    • The report URL in SuccessFactors will prompt the user to log in to deverus before viewing the report.

  • Report Link without Login

    • The report URL in SuccessFactors will take the user directly to a copy of the report (no deverus login prompt).

4. Enable SwiftHire (if applicable)

  • If the client is using SwiftHire for candidate-facing data and consent collection, toggle SwiftHire to On.

  • If the client is not using SwiftHire, leave SwiftHire off and ensure required applicant data is captured in SuccessFactors instead.

5. Enter SuccessFactors Connection Details

Using the information provided by your client, enter:

  • Company ID (Customer ID)

  • API username

  • API password

  • SuccessFactors OData API endpoint URL

  • Any additional configuration requested by deverus (for example, status IDs or environment flags)

Follow the on-screen prompts in IM. If anything is unclear, contact deverus Support for assistance.

6. Save Configuration

  • Click Save to store the connection details.


Map Packages

  1. Locate the client account you just configured in IM.

  2. Navigate to the Package Mapping or Map Fields section (label may vary).

  3. For each package you want exposed in SuccessFactors:

    • Enter the corresponding SuccessFactors package value (for example, the externalCode or label from the CUST_bgPackage picklist) as the Integration Partner Package ID or equivalent.

  4. Save your mappings.


Map Locations

If the integration will differentiate locations/branches:

  1. Locate the same client account in IM.

  2. Navigate to Location Mapping or Map Fields.

  3. For each client branch/location:

    • Enter the corresponding identifier used in SuccessFactors as the Integration Partner Location ID or equivalent.

  4. Save your mappings.


Test the Integration

Work with your client to perform a full roundtrip test.

1. Client Creates a Test Requisition and Candidate in SuccessFactors

  • They configure the Job Application to use the background-check-enabled template and statuses described in the Configuration Guide.

2. Client Initiates a Background Check

  • On the Job Application, the client selects a test background package (CUST_bgPackage).

  • They move the candidate into Background Verification Initiated.

3. Verify Order Creation in deverus

  • Log into deverus as the client.

  • Confirm that:

    • An order has been created with the expected package and location.

    • If the client is using SwiftHire, a SwiftHire invitation has been created.

    • The client sees the expected initial integration status in SuccessFactors:

      • For candidate-driven (SwiftHire) flows, this may be “Pending Candidate.”

      • For non–SwiftHire flows, the candidate may move directly to an “In Process” status.

4. Complete the SwiftHire Flow (if using SwiftHire)

  • As the test applicant, complete the SwiftHire invitation.

  • Have the client confirm that the SuccessFactors Application Status and BG Order/Result fields update to show a Pending / In Process state.

If the client is not using SwiftHire, skip this step and proceed directly to completing the report in deverus. The order should remain in an “In Process” state until the report is completed.

5. Complete the Report in deverus

  • Complete the test report in your deverus admin tools.

  • Have the client confirm that:

    • The SuccessFactors Application Status changes to Background Verification Complete or Background Verification On Hold (for graded results).

    • The BG Result Status, BG Summary, and BG Report Link fields are populated.

    • They can open the report URL (with or without login, depending on the selected result delivery option).

6. Review and Sign Off

  • Confirm that all fields and statuses in SuccessFactors match the behavior described in the Recruiter Workflow Guide.

  • Once everyone is satisfied, the integration is ready to use.


Special Notes & Considerations

  • Each job requisition that requires a background check should have a clear package and location strategy so recruiters know which package to choose.

  • Recruiters should be trained:

    • To only trigger the integration by moving candidates into Background Verification Initiated.

    • Not to manually move candidates into In Process / Complete / On Hold / Failed unless instructed by an admin.

  • Changes to Application Status names/IDs or custom field IDs in SuccessFactors after go-live must be coordinated with deverus; otherwise the integration may stop updating correctly.

  • For troubleshooting, encourage clients to involve:

    • Their SuccessFactors admin or consultant, and

    • deverus Support (especially if they purchased the premium support package).


Guides & Documentation

Share the documents attached to this article with your client/their consultant as part of the SuccessFactors integration project:

  • Configuration Guide for SuccessFactors Administrators

  • Recruiter Workflow Guide for SuccessFactors × deverus Integration

  • Technical Overview for SuccessFactors × deverus Integration (optional, for client IT/technical teams)

  • deverus Integration IP Addresses (for the client’s network/security team)

Did this answer your question?