For the complete documentation index, see llms.txt
For the complete documentation index, see llms.txt
Zinc
Help center
How to Integrate Zinc with SuccessFactors for Background Checks
**Please note that CV checks are only available directly on Zinc. SuccessFactors cannot currently be used with packages containing CV checks.**
<iframe
src="https://www.youtube.com/embed/g1Nm7i6YEQM"
width="100%"
height="400"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
></iframe>
## How to integrate Zinc with SuccessFactors
There are four main parts to the integration setup process:
### A. Creating the Zinc integration
Before starting, ensure you have received the Integration Definition document and Password from Zinc. You can request this on the Company Settings page in Zinc by:
- Clicking the Company tab, selecting Integrations, and choosing SuccessFactors.
- Clicking Get in contact to set up to receive the necessary information.
1. **Enable Zinc as a background check vendor in SuccessFactors**
- Search for Background Check Center.
- Turn on Enable Background Check in Recruiting.
- Select Other Background Check Vendor and save.
2. **Add background check packages**
- Search for Picklist Center.
- Create a new picklist with code zincPackages, name zincPackages, and Effective Start Date as 1 January 1900 (this is the standard effective start date for SuccessFactors).
- Add existing Zinc packages to this picklist using package external codes provided by Zinc. New packages will sync automatically once integration is complete.
3. **Add Zinc as an external vendor**
- Search for Manage Data.
- In the **Create new field**, search for **Recruiting External Vendor**
- Add Zinc as a Vendor with these values:
- External Code: ZN
- Vendor Name: Zinc
- Integration Type: Background Check
4. **Create the Zinc integration within SuccessFactors**
- Search for Integration Center.
- Click + Create and select Import Integration Definition.
- Upload the .icd file from Zinc.
- Name the integration Zinc Background Checks.
- In Destination Settings, add your SuccessFactors Company ID (found in Settings > Show version information) as the User Name and enter the password from Zinc.
- Save the integration.
5. **Map the Zinc integration to the Zinc vendor**
- Search Manage Data.
- Create new Recruiting Vendor Integration Mapping.
- Map Zinc Background Checks integration to Zinc vendor code (ZN) and set it as the default integration.
### B. Updating your recruitment settings
1. **Enable the Background Check status**
- Search Edit Applicant Status Configuration.
- Select the status set used by your job requisition template.
- Add a new status named Background.
- Make Background visible by enabling for internal and/or external candidates.
- Update internal and candidate labels to Background Check.
2. **Add permission role to users**
- Users initiating background checks need permission:
- Manage Integration Tools: Allow execute Application/UI or Event-based integrations.
- Recruiting Permissions: 0Data API Application Export.
- Assign appropriate permission roles to these users.
3. **Add the Packages selection dropdown**
- In Provisioning, open Import/Update/Export Job Requisition Template.
- Edit your job requisition template (code editor) to insert:
```xml
<field-definition id="packageId" type="picklist" required="false" custom="false">
<field-label><![CDATA[Zinc Package ID]]></field-label>
<field-description><![CDATA[Zinc Package ID]]></field-description>
<picklist-id>zincPackages</picklist-id>
</field-definition>
```
- Within the relevant role field-permissions (e.g. **<field-permission type="read">**), add: **<field refid="packageId"/>**. These determine which roles can view (i.e. **“read"**) and/or select (i.e. **“write"**) the Zinc checks package, and at what stage in the process.
- We’ll be updating this template for the next step too, so do not upload the updated template yet. Once the new template has been uploaded, the package selection dropdown will be visible from any Job Requisition created with this template:
4. **Add Initiate Background check option**
- In the same job requisition template, within <application-status-config>, add:
```xml
<feature-permission type="backgroundCheck">
<description><![CDATA[The following roles can launch a background check during the Background status]]></description>
<role-name><![CDATA[O]]></role-name>
<status><![CDATA[Background]]></status>
</feature-permission>
```
- Add any other necessary role-names within the permission above (in the example above only the ‘Originator’ has been given the initiate background check option).
- Now once a candidate has been moved to the **Background Check** stage, within **Take Action** there will be an **Initiate background check** option, which will trigger the Background Check request to Zinc .
### C. Accepting results from Zinc
You will need an X509 certificate from Zinc for this section.
1. **Create a new ZINC_API user**
- In Admin Center, search **Import Employee Data**.
- Download and generate the Basic Import template.
- Populate the CSV:
- Status: active
- User ID: ZINC_API
- Username: ZINC_API
- First name: ZINC
- Last name: API
- Email: zinc+api@example.com (any value)
- Manager: NO_MANAGER
- HR: NO_HR
- Default locale: en_US
- Click on **Download Template** and then **Import Data**
- Click on the field next to **Select an entity** and then on **Basic Import**
- Click on **Browse** and select your **.csv** file to upload
- Click on the **Validate Import File Data** button
- If you see the "Validation Successful" dialog, click on the **Import** button
2. **Create a permissions group**
- Search for **Manage Permission Groups** and click **Create New**
- Name the group i.e. Zinc API Group and under **People Pool** select the category **Username**
- Search for the ZINC_API user, select them and click **Done**
- ZINC_API should now appear in the People Pool. Click **Done** again
3. **Assign permissions to the Zinc API permissions group**
- Search for **Manage Permission Roles**
- Create a new permission role (i.e., Zinc API Permissions).
- Add the following permissions:
- Manage System Properties: Picklist Management and Picklists Mappings Set Up
- Recruiting Permissions: OData API Application Create
- Recruiting Permissions: OData API Application Export
- Recruiting Permissions: OData API Application Update
- Recruiting Permissions: OData API Attachment Import
- Recruiting Permissions: OData API Candidate Create
- Recruiting Permissions: OData API Candidate Update
- Recruiting Permissions: OData API Candidate Export
- Recruiting Permissions: OData API Job Requisition Export
- Assign this role to the Zinc API Group.
4. **Create an application to authenticate results from Zinc**
- Search Manage OAuth2 Client Applications and select Register New Client Application.
- Copy the X509 certificate (only the value between -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----).
- Select bind to user and enter ZINC_API as the username.
- Name the application Zinc Background Check Response.
- Application URL: https://api.zincwork.com/
- Register and then view the application by clicking **View** to copy the API Key. You'll need
### D. Sharing credentials with Zinc
Securely provide the following to Zinc:
- Client Application API key (from above step)
- SuccessFactors tenant domain (e.g., hcm-eu10.hr.cloud.sap)
- SuccessFactors API server URL (e.g., https://apisales3.successfactors.eu/)
- SuccessFactors Company ID (e.g., SFXXX3333) - also used as User Name in the integration destination settings
## What happens next
**Let Zinc work**
Zinc will contact your candidate via email and text asking them to complete the selected background checks and send automated reminders to ensure timely completion.
**Track the progress**
You can view the status of each candidate’s checks in your ATS. Zinc will notify you by email as soon as individual checks are completed.
**View insights**
Candidate reports can be viewed directly within your ATS to support better hiring decisions without leaving your ATS or HRIS.
