Enabling and using the ClearStar integration

Available for Roles Super Admin, Admin, Team Member, Limited Team Member
Can only be enabled by Super Admins
Permissions • (To enable) Manage API credentials and manage integrations
• (To use) Manage profiles and view associated postings
Packages LeverTRM, LeverTRM for Enterprise

The ClearStar integration streamlines 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 the capture of all required data and electronically signed documents. Recruiters will have access to background check status updates within Lever. In addition, recruiters and candidates alike can be provided access to the final background check results.

Setting up the ClearStar integration


You must be a team or organization with admin rights in ClearStar to install this integration.

Customers will be asked to create a service account (eg clearstar@customerdomain.com) with Super Admin access to enable the integration. The role level can be removed after enablement is complete. Please review the Lever-ClearStar Enablement Procedure:Service Account document attached at the bottom of this article. 

Integration Request Process

1. Customer to coordinate with ClearStar for the following details: 

  • Service Package(s) to be available with the Lever integration 
  • Accounts/Customer(s) to be available with the Lever integration 
  • Contacts as it relates to integration configuration   
  • Contacts as it relates to training, if needed 
  • Outline requirements based on service package(s) 
  • Define the candidate experience 

2. Customer to add packages in the Job posting (as a tag) on Lever. Packages may be set at the candidate opportunity level upon creating a new opportunity in Lever. 

3. Customer to provide temporary credentials for Lever to their ClearStar implementation manager to configure the oAuth.  The credentials can be removed after the integration setup is complete. 

Enabling the Integration

The ClearStar integration will require authorization of the following scopes:

  • notes:write:admin
  • resumes:read:admin
  • stages:read:admin
  • opportunities:write:admin
  • tags:read:admin
  • offline_access

Configuring the ClearStar integration

Configuring the webhook

To integrate ClearStar with Lever, create the following webhook in the Lever:

Candidate Stage Change webhook tile with url field outlined

There are some specific settings to be done in the ClearStar application => “ScreenMeNow” (SMN). These settings will be fulfilled by the ClearStar Implementation Team.

Configuring the Package Tags

The integration package tags will manage the following important details:

  1. The package/s
  2. The status for changes on the background check process
  3. Customer names

The Package/s can be configured on the job posting or directly on the candidate opportunity on Lever, using the following syntax:

  • ClearStar-Pkg-[PackageName] (e.g. "ClearStar-Pkg-Lever Package 1")

The status changes will be created and visualized automatically on the Candidate dashboard in Lever and within the candidate opportunity.

Configuring Customers/Accounts

Multiple ClearStar customer accounts can be accommodated, please ask your ClearStar implementations manager for more details.

Field Mapping to Clearstar

To ensure proper data mapping from Lever to Clearstar, it will be necessary to upload the candidate's resume to the Lever opportunity so that the candidate information can be used for the integration:

Candidate Data: The integration requires the following candidate data:

  1. First Name
  2. Last Name
  3. Email address

All available personal information that can be retrieved from the candidate’s resume will be passed through the integration and pre-populated onto the Clearstar application. For example: First Name, Last Name, Email Address, etc.

Employment and Education: Employment and Education information will be passed through the integration and pre-populated onto the Clearstar application.

Using the ClearStar integration

Workflow summary

Below is a brief overview of the workflow steps for the Lever to Clearstar integration:

  1. Create a candidate in Lever
  2. Upload candidate’s resume
  3. Add the tag for the package to be used
    • To streamline package tagging, the tag can be configured on the job posting. Once configured, the package tag will be applied to all associated candidate opportunities.
  4. Move the candidate to the stage selected to trigger the background check
  5. Background check is initiated
  6. Candidate receives email invitation
  7. Status change tag added to the candidate's opportunity in Lever
  8. Candidate completes background check information
  9. Status change tag updated on the candidate's opportunity in Lever
  10. Background check vendor works on order(s) / screening(s)
  11. Background check vendor completes profile background check
  12. Candidate's opportunity is updated with the completed statuses and options
  13. Report link generated and added to the candidate's opportunity in Lever

Background check workflow steps

Each client will need to have a candidate workflow step that will trigger the ClearStar background check. The default workflow steps supported by ClearStar for Lever creates a new candidate and then searches for it to perform the flow to submit the background check.

  • In Lever, create a candidate
    • From the Candidates page, click + Add Candidate and select Add Manually

Menu extending from Add Candidate in Lever platform header with options to Add Manually, Add Referral, and Bulk Import Candidates

    • Complete the following:
      • Add name
      • Add organization
      • Select a job posting to assign to the candidate

Candidate profile in Lever with name, organizationm, and job fields outlined

    • Add resume

Close up of Add resume field on candidate profile

    • Add package tag (e.g. "ClearStar-Pkg-Lever Package 1")

ClearStar Package tag on candidate profile

    • Move the candidate to the stage selected to trigger the background check (e.g. “Offer”)
  • The integration adds the "In Progress - Candidate" tag, indicating that the candidate has started the background check process. i.e. "ClearStar-Status-In Progress-Candidate"

ClearStar status in progress tag

  • Once the candidate has finished the process, a status change is posted to Lever meaning that the vendor started the work on order(s) / screening(s) i.e. “ClearStar-Status-In Progress - Vendor”

ClearStar status in progress tag

  • Once the background check is finalized, the integration will update the Lever opportunity with a status change tag, view status and URL report link. 

Status change tags:

  • In Progress – Candidate
  • In Progress – Vendor
  • Complete
  • Complete – Not Eligible
  • Complete – Eligible
  • Complete – Decisional
  • Complete – Needs Review


  • Old status tags will be removed when new ones are added (package names will remain as it happens today).
  • In this way there will be only one visible candidate's status update => the latest one, in the case of the Complete status variations, always the LAST one must be visualized.

For example: The ClearStar integration first adds the tag "ClearStar-Status-In Progress - Candidate". The next status tag will be "ClearStar-Status-In Progress - Vendor", so the previous status "ClearStar-Status-In Progress - Candidate" will be removed. Only the status tag, "ClearStar-Status-In Progress - Vendor" will be visible on the candidate opportunity. 

Candidate profile with ClearStar package and status tags

URL report link:

Report link outlined in Notes section of candidate's profile in Lever

Report example

Example of a ClearStar report

Disabling the ClearStar integration

  • In Lever, navigate to Settings > Integrations and API
  • Under the 'Authorized Apps' tab, locate the ClearStar app
  • Click Revoke Access to disable the integration
Was this article helpful?
0 out of 0 found this helpful