ClearStar provides employers and companies across the globe with pre-employment background check software, screening services, and tools they need to quickly, easily, and confidently welcome new individuals to their team.

Greenhouse Recruiting’s integration with ClearStar will streamline the background screening process for recruiters and candidates. Recruiters can initiate the background check process, which will include an element of candidate engagement, via a ClearStar application, to ensure capture of all required data and electronically signed documents. Recruiters will have access to background check status updates within Greenhouse Recruiting, and recruiters and candidates can access the final background check results.

Greenhouse Recruiting’s integration with ClearStar allows users to source, access, engage, and track candidates from ClearStar.

Create a Harvest API key for the Greenhouse Recruiting / ClearStar integration

To configure the Greenhouse Recruiting / ClearStar integration, 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 Clearstar integration.


In the Create New Credential box, make the following selections:

  • API Type: Harvest
  • Partner: Clearstar (optional)
  • Description: ClearStar Harvest API Key


Verify that the following permissions are selected for the ClearStar integration: 


  • Delete: Delete Candidate
  • Get: Retrieve Candidate
  • Get: List Candidates
  • Patch: Edit Candidate
  • Post: Add Candidate
  • Post: Add Note
  • Post: Add E-mail
  • Post: Add Attachment
  • Post: Add Application
  • Post: Add Education
  • Delete: Delete Education
  • Post: Add Employment
  • Delete: Delete Employment
  • Put: Anonymize Candidate
  • Put: Merge Two Candidates


  • Get: List Application’s Offers
  • Get: Retrieve Application’s Current Offer
  • Get: Retrieve Offer
  • Get: List Offers
  • Patch: Update Application’s Current Offer

Activity Feed:

  • Get: Retrieve Activity Feed


  • Get: Retrieve Job
  • Get: List Jobs
  • Patch: Update Job
  • Post: Create a New Job
  • Get: Get Hiring Team
  • Post: Add Hiring Team Member
  • Delete: Remove Hiring Team Member
  • Put: Replace Hiring Team Member

Configure a webhook

To integrate ClearStar with Greenhouse Recruiting, you’ll need to create a webhook. Follow the steps in this articleto create your webhook.

Use the values listed below to configure the webhook:

  • Name: ClearStar Web Hook API
  • When: Candidate has been hired 
  • Endpoint URL: The Endpoint URL provided by ClearStar
  • Secret Key: The Secret Key provided by ClearStar
  • Basic Authorization Credentials (in Advanced Settings): Username & Password for the integration. ClearStar will provide these credentials; note the password will always be hidden.

Create a background check package using Custom Options

You'll need to create a background check package in Greenhouse Recruiting to use the integration. To create a background check package, navigate to Custom Offers in Greenhouse Recruiting. (Configure > Custom Options

Below the Company Custom Fields list, click Offers.


Click Add Field.


Enter the following information

  • Field Name: ClearStar_BGC_Package
  • Description (optional): ClearStar Package
  • Field Type: Single Select
  • Options: Enter the package values supplied by ClearStar 

Click the box next to Required, then click Save.


Use the ClearStar integration with Greenhouse Recruiting

Education and employment

ClearStar retrieves the candidate’s data and populates it into the ScreenMeNow application, giving the candidate a seamless and efficient process. Education and employment history are retrieved from the candidate’s Greenhouse Recruiting candidate details.

Note: Employment fields must be turned on for your Greenhouse Recruiting instance by a Greenhouse CSM. This is not a default feature in Greenhouse Recruiting and must be requested. If this setting is not turned on in your Greenhouse Recruiting instance, the candidate will need to enter their past employment details during their application process.


Workflow for Greenhouse / ClearStar Integration

Note: The Hire Candidate workflow step triggers the ClearStar background check. It is important to ensure that all users have access to the Hire Candidate workflow step.

Find the candidate you want to initiate a background check for by navigating to the Candidates tab, then search for the candidate's name. 

On the candidate's profile, click Move Stage


In the popup window that appears, click Offer.


Click Manage Offer. Then click Mark Candidate as Hired.


In the Accept Offer window, select your ClearStar customer account and the background screening package from the dropdown menu options.


When finished, click Save and mark the candidate as hired. This initiates the invite to the candidate, which is sent from ClearStar.

Below is a sample email:


Note: If the candidate has provided a mobile number and your ClearStar integration settings are enabled for text invitations, the candidate will also receive a text message invite to begin the screening application.

All background screening information is housed in the candidate’s Activity Feed.


Once the candidate has completed their portion of the background screening application, the ClearStar Report Status updates to In Progress-Vendor.

Once the screening is completed, the Report Status updates to Complete or Complete – Review (if the profile is flagged).

If your organization is using the ClearStar scoring matrix, the statuses could be Complete – Eligible, Decisional, or Not Eligible.

The completed report is available in the report link. Clicking on the report link takes you to ClearStar’s secure portal so you can sign in and access the completed report.


Additional resources

For additional information not covered here, reach out to the ClearStar Implementation Team: