Private Eyes is one of only a few companies in the industry that has developed their own easy-to-use background screening platform, resulting in faster results for background screening, verifications, and drug testing.
Greenhouse Recruiting's integration with Private Eyes makes it simple to onboard candidates, submit background check orders, send candidate screening invites, track their progress, view reports, and even initiate adverse action letters directly in one system.
Set up the Private Eyes integration
Configure custom options
Note: To configure custom options, you'll need to be a Site Admin or a Job Admin with the additional user-specific permission 'Can manage custom fields'.
To configure the Private Eyes integration, you'll need to add a custom offer field.
To add a custom offer field for the Private Eyes integration, click Configure and select Custom Options from the left-hand panel.
Under Company custom fields, select Offers and then, click Add field.
Make the following selections on your new custom offer field:
- Field Name: PackageCode
- Description: Package Code
- Field Type: Single select
- Options: Standard Package, Standard Package with MVR
- Click Required
Note: Be sure to add background check packages to the Options field with each package separated by a line break.
When finished, click Save.
Create a Harvest API key
Next, you’ll need to create a Harvest API key.
Follow the steps in this article to create the key, and verify that the permissions below are selected when configuring the Private Eyes integration.
Credentials
In the Create New Credential box, make the following selections:
- API Type: Harvest
- Partner: Private Eyes (or Unlisted Vendor)
- Description: Private Eyes Harvest API Key
Permissions
Verify that the following permissions are selected for the Private Eyes integration:
Candidates
- GET: Retrieve candidate
- GET: List candidates
- POST: Add note
Users
- GET: Retrieve user
- GET: List users
Activity Feed
- GET: Retrieve activity feed
Custom Field Options
- GET: Custom field options
- POST: Create custom field options
- PATCH: Update custom field options
When finished, click Save.
Your Harvest API key for the Private Eyes integration is created and configured. Provide your Harvest API key to your Private Eyes onboarding team so they can finish setting up the integration.
Create a web hook and complete setup
To integrate Private Eyes with Greenhouse Recruiting, you'll also need to create a web hook.
Note: Greenhouse Recruiting requires two pieces of information to configure a new web hook for your integration: the Private Eye's endpoint URL and Private Eye's secret key.
To retrieve this information, contact Private Eye Support and include the following subject line:
- Greenhouse Endpoint URL & Secret Key Request: [YOUR COMPANY NAME]
Once you receive the Private Eyes endpoint URL and secret key, you can create a new web hook by following the steps in this article. Use the values listed below to configure the web hook:
- Name: Private Eyes Integration
- When: Candidate has been hired
- Endpoint URL: The Endpoint URL provided by Private Eyes
- Secret Key: Enter the Secret Key provided by Private Eyes
Your Greenhouse Recruiting and Private Eyes integration is now configured and complete.
Use the Private Eyes integration
Submit a background check order
To place a Private Eyes order, navigate to a candidate's profile and click Details. Confirm the following information is complete:
- Candidate's First Name
- Candidate Last Name
- Candidate Email Address
Note: For the order to process successfully, you must have a valid account in the Private Eyes platform, and your email address in Greenhouse Recruiting and Private Eyes must match.
Next, click the On Job tab and navigate to Offer Details on the left-hand side.
Click Mark Candidate as Hired.
In the Accept Offer window, fill in the necessary fields and select the Package Code.
Click Save. The order will then be created in Private Eyes.
Track status of background check order
You can track the status of the background check in the Activity Feed of the candidate's profile in Greenhouse Recruiting.
To view a background check's details, click the link in the Activity Feed note from Private Eyes.
View final background check report
Once a background check report is completed, Private Eyes will send an email notification to the user who marked the candidate as hired.
Private Eyes also posts a status update in the candidate's Activity Feed. To see the final background check, click the link in the Activity Feed.
Additional resources
For additional troubleshooting or information not covered here, reach out to Private Eyes Support.