For the complete documentation index, see llms.txt
For the complete documentation index, see llms.txt
Zinc
Help center
How to Integrate Zinc with Workday: Step-by-Step Guide
## Step 1 - Create ISU user in Workday
- Create an integration system user (ISU) with the **Create Integration System User task** in Workday. Name the user **Zinc Background Check ISU**.
- Give the ISU a password (Zinc will not require this).
- Uncheck the box stating **Require New Password at Next Sign In**.
- Check the box stating **Do Not Allow UI Sessions**.
- Click **OK**.
## Step 2 - Create security group
These configuration steps are all actioned within your Workday tenant.
- Access the **Create Security Group** task.
- From the dropdown, select **Integration System Security Group (Unconstrained)**.
- Name the security group **Zinc Background Check ISSG**.
- Click **OK**.
- In the next, under **Integration System Users** search for and select the **Zinc Background Check ISU**.
- Click **OK**.
- Access the **Maintain Permissions for Security Group** task.
- Assign these permissions to the **Zinc Background Check ISSG** group.
| Access | Domain Security Policy | Functional Area | Purpose |
| --- | --- | --- | --- |
| Get and Put | Candidate Data: Attachments | Recruiting | |
| Get and Put | Candidate Data: Background Check History | Recruiting | |
| Get and Put | Candidate Data: Job Application | Recruiting | |
| Get and Put | Candidate Data: Other Information | Recruiting | |
| Get Only | Candidate Data: Personal Information | Recruiting | |
| Get and Put | Custom Object Management | System | (Optional) Sending Additional Data |
| Get | Job Requisition Data | Pre-Hire Process | |
| Get Only | Manage Pre-Hire Process: Manage Pre-Hires | Pre-Hire Process | Get contact information of ‘Applicants’ |
| Get Only | Person Data: Home Contact Information | Contact Information | |
| Get Only | Person Data: Work Contact Information | Contact Information | |
| Get and Put | Pre-Hire Data: Background Check Status | Pre-Hire Process | |
| Get Only | Pre-Hire Data: Name and Contact Information | Pre-Hire Process | Get contact information of ‘Applicants’ |
| Get and Put | Set Up: Background Check | Pre-Hire Process | Update Background Check Package statuses |
| Get and Put | Set Up: Recruiting Talent Pipeline | Recruiting | Add / remove Background Check packages |
| Get and Put | Worker Data: Add Worker Documents | Personal Data | |
| Get and Put | Worker Data: Background Check Status | Personal Data | |
| Get Only | Worker Data: Public Worker Reports | Staffing | |
| Get and Put | Worker Data: Workers | Staffing | (Optional) Sending Additional Data |
- Activate the security group changes by accessing the **Activate Pending Security Policy Changes** task.
## Step 3 - Create an API client for integrations
These configuration steps are all actioned within your Workday tenant.
- Access the **Register API Client for Integrations** task.
- Name the Client **Zinc API Client**.
- Select **Non-Expiring Refresh Tokens**.
- Add the following to **Scope (Functional Areas)**.
- Contact Information
- Personal Data
- Pre-Hire Process
- Recruiting
- Staffing
- Tenant Non-Configurable
- Worker Profile and Skills
- Select **Include Workday Owned Scope**.
- Click **OK**.
- Make a note of the **Client ID** and the **Client Secret** that are generated. You’ll need to input them into Zinc later.
- Click **Done**.
- Access the **View API Clients** task.
- Make a note of the **Workday REST API Endpoint**. You’ll need to input it into Zinc later.
- Select the **API Client for Integrations** tab.
- Find the **Zinc API Client**, then open the related actions by clicking the ellipsis.
- Select **API Client** > **Manage Refresh Tokens for Integration**.
- Under **Workday Account**, select **Zinc Background Check ISU**.
- Click **OK**.
- On the next screen, select **Generate New Fresh Token**.
- Click **OK**.
- Make a note of the **Refresh Token**. You’ll need to input it into Zinc later.
- Click **Done**.
## Step 4- Add statuses and document category
### Document category
Create a document category for the Zinc Background Check report.
1. Access the **Maintain Document Categories** task.
2. Scroll past the Workday delivered categories.
3. Press the + button to create the new category.
4. Create the category **Background Check Report** with the ID **Background_Check_Report**.
If you wish to use a different document category please let us know (the ID must have capitalised words with underscores e.g. **Background_Check_PDF**. We cannot upload documents against existing Workday Delivered categories).
### Background check statuses
1. Check that the following Background Check Statuses exist in your tenant (with the relevant Reference ID Values) by accessing the **View Reference ID** task for the **Background Check Status** Business Object.
2. Update the Reference ID Values to **Passed**, **Pending** and **Did_Not_Pass** if necessary, by accessing the **Edit Reference ID** task for the **Background Check Status** Business Object.
3. Access the **Maintain Background Check Statuses** task.
4. Ensure the **Passed**, **Pending** and **Did Not Pass** statuses have **Restricted To** values of **Overall Status**, **Package Status**, and **Test Status**.
## Step 5 - Input credentials into Zinc
You should now have a **Client ID**, **Client Secret**, **Refresh Token**, and **Workday REST API Endpoint**. You can now complete the integration within Zinc.
- Sign into Zinc, and head to https://app.zincwork.com/company/general.
- Select **Integrations**, then under **Workday** select **Setup Integration**.
- Paste the **Client ID**, **Client Secret**, and **Refresh Token** into the relevant fields.
- **Tenant Host Name** and **Partner Domain** are take from your **Workday REST API Endpoint**.
- **Tenant Host Name** is made from the Scheme and Domains of the URL. In the example above, the Tenant Host Name is https://impl-services1.wd12.myworkday.com.
- The **Partner Domain** is the final path of the URL. In the example above, the Partner Domain is **zinc_dpt1**.
- Once you’ve added all fields, click **Establish Connection to Workday**.
- **Set-up is now complete!**
## (Optional) Step 6- Create customer objects for additional data
Zinc can optionally send back additional data into Workday for Criminal, Qualification and Right to Work checks.
As Workday treats candidates and workers separately, two Custom Objects must be created to hold this data (one for candidates and one for workers).
(Note - each of these fields are optional, therefore you only need to create the data fields you want Zinc to return).
### Candidate custom object
- Access the **Create Custom Object** task.
- Under **Workday Object**, select **Job Application**.
- Name your custom object e.g. **Zinc Background Check Data (Candidate)**.
- Update the **Web Service Alias** to **zincDataCandidate**.
- Do not allow Multiple Instances per Object.
- Create the data fields you’d like Zinc to return. The fields can have any name, but the web alias must match the alias specified below.
| Name | Web Alias | Field Type |
| --- | --- | --- |
| Criminal DBS Barred List | criminalDbsBarredList | Text |
| Criminal DBS Level | criminalDbsLevel | Text |
| Criminal DBS Update Service | criminalDbsUpdateService | Text |
| Criminal DBS Workforce | criminalDbsWorkforce | Text |
| Criminal Result | criminalResult | Text |
| Qualification Award Date | qualificationAwardDate | Date |
| Qualification Expiry Date | qualificationExpiryDate | Date |
| Qualification Level | qualificationLevel | Text |
| Qualification Type | qualificationType | Text |
| RTW Document Type | rtwDocumentType | Text |
| RTW ExpiryDate | rtwExpiryDate | Date |
| RTW Nationality | rtwNationality | Text |
| RTW Restrictions | rtwRestrictions | Text |
- Under **Permissions** > **Security**, select **Candidate Data: Job Application** for domain.
### Worker custom object
- Access the **Create Custom Object** task.
- Under **Workday Object**, select **Worker**.
- Name your custom object e.g. **Zinc Background Check Data (Worker)**.
- Update the **Web Service Alias** to **zincDataWorker**.
- Do not allow Multiple Instances per Object.
- Create the data fields you’d like Zinc to return. The fields can have any name, but the web alias must match the alias specified below.
| Name | Web Alias | Field Type |
| --- | --- | --- |
| Criminal DBS Barred List | criminalDbsBarredList | Text |
| Criminal DBS Level | criminalDbsLevel | Text |
| Criminal DBS Update Service | criminalDbsUpdateService | Text |
| Criminal DBS Workforce | criminalDbsWorkforce | Text |
| Criminal Result | criminalResult | Text |
| Qualification Award Date | qualificationAwardDate | Date |
| Qualification Expiry Date | qualificationExpiryDate | Date |
| Qualification Level | qualificationLevel | Text |
| Qualification Type | qualificationType | Text |
| RTW Document Type | rtwDocumentType | Text |
| RTW ExpiryDate | rtwExpiryDate | Date |
| RTW Nationality | rtwNationality | Text |
| RTW Restrictions | rtwRestrictions | Text |
- Under **Permissions** > **Security**, select **Worker Data: Workers** for domain.
### Additional documents
Zinc can also send back Right to Work documents and Qualification documents as separate attachments into Workday.
- Access the **Maintain Document Categories** task.
- Scroll past the **Workday Delivered Categories** table.
- Click the **+** sign (**Add Row**) to create new categories.
- For Qualification Document, the ID must be **Qualification_Document**.
- For Right to Work Document, the ID must be **Right_To_Work_Document**.
- Click **OK**.
📌 Please let your **Account Manager** know whether you’d like additional documents or additional data sent back into Workday (and which additional data fields / documents), so we can complete the configuration for this on our side.
