JDP’s bi-directional integration with Greenhouse Recruiting allows you to easily initiate a pre-employment background check on candidates directly within Greenhouse with just a few clicks.

Once a background check is initiated, information entered into Greenhouse is pre-populated in the background check form. Then, an email is sent to the candidate to obtain any additional information and the consent to perform the background check.

With seamless access and an interactive workflow for managing background screening requirements, the solution offers a fast, simple, and intuitive user and applicant experience, allowing you to increase workforce productivity, reduce time-to-hire, and get more, high-quality hires.

Set up the JDP integration

Create a Harvest API key

To configure the JDP 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 JDP integration.


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

  • API Type: Harvest
  • Partner: JDP or Unlisted Vendor
  • Description: JDP Harvest API Key


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


  • GET: Retrieve Application
  • GET: List Applications
  • PATCH: Update Application
  • POST: Advance Application
  • POST: Move Application
  • POST: Reject Application


  • GET: Retrieve Candidate
  • GET: List Candidates
  • PATCH: Edit Candidate
  • POST: Add Note


  • DELETE: Remove tag from Candidate
  • GET: List tags applied to Candidate
  • GET: List Candidate Tags
  • POST: Add New Candidate Tags
  • PUT: Add a candidate tag
  • DELETE: Remove Candidate Tags

Custom Fields

  • GET: Get custom fields

Job Stages

  • GET: Retrieve Job Stages
  • GET: List Job Stages
  • GET: List Job Stages for Job


  • GET: Retrieve Job
  • GET: List Jobs


  • GET: List Users

When finished, click Save.

Your Harvest API key for the Greenhouse Recruiting / JDP is configured. Copy your key to provide to JDP in a later step

Additional configuration to complete setup

Create custom Job fields

Next, in order to use the JDP integration, you'll need to create three custom Job fields in Greenhouse Recruiting.

To create these fields, navigate to Configure Configure icon > Custom Options > Jobs and then, click Add field. Enter the following details to configure the new fields:

Custom job field #1

  • Name: Background Check Package Name
  • Type: Single Select
  • Options: Enter all the package names JDP has configured for your company.
  • Select both Mark private and Required check boxes

Save when finished.

Once done, an Immutable field key will be generated. You will need to provide this key to JDP.

A screenshot of a computer Description automatically generated

Custom job field #2

You will now need to create a second custom job field to represent sub client names; this is optional and only created if the client has a parent and child accounts;  similar to the other custom job field, follow these steps:

  • Name:, enter Child Client Name
  • Type: Single Select
  • Options: Enter either the name or code for all your accounts – do not mix names and codes – choose only one approach
  • Select the Mark private check box

Save when finished.

Once done, an Immutable field key will be generated. You will need to provide this key to JDP.

A screenshot of a computer Description automatically generated

Custom field option #3

Last custom job field to create is the Requestor Name field.

  • Field Name: Job Order Requestors
  • Type: Single Select
  • Options: Enter the names of all users who will be submitting orders
    • Format as LastName, FirstName
  • Select the Mark private check box

Save when finished.

Once done, an Immutable field key will be generated. You will need to provide this key to JDP.

A screenshot of a computer

Description automatically generated

To learn more about creating custom job fields, check out this guide

Use the JDP integration with Greenhouse Recruiting

Add the JDP assessment to your interview plan

After enabling the JDP integration, you'll need to add the 5 JDP Background check stages to your job's interview plan to facilitate the background check ordering process. The 5 stages will need to be named exactly as shown.

Note: If your company utilizes job templates for creating new jobs, you'll want to update the template to include the JDP stages.

The Background Check Package Name field appears for the user to select a package from the list of choices we had created previously.

Now that the user is in the Interview plan section, click on the Add Stage button.

Create a new stage named Background Check Requested and then, click Add

Repeat the above process to create the additional stages:

  • Background Check In-Process
  • Background Check Completed
  • Background Check Canceled
  • Background Check Error

Create an integration service user (ISU)

In order to send information from JDP to Greenhouse Recruiting using the Harvest API, JDP will need a Greenhouse Recruiting user ID to associate with the data. This user account must be a Site Admin, but does not require any additional user-specific permissions. Use the steps listed below to create a new user for this integration:

Click the Configure icon and then, select the Users tab. Click +New Users and enter the email address for the API User; this user is purely for connection between Greenhouse and JDP.  Provide this email address to JDP when created.

Select the Assign button for the Site Admin and enable all permissions that display.

A screenshot of a computer Description automatically generated

Save when finished. 

Provide your credentials to JDP 

At this point, the JDP integration team will need to configure the integration within your JDP account. Please provide the following to your JDP implementation team contact(s):

  • Immutable Field Key(s)
  • ISU user email address
  • API Key

Send the above information to: greenhouseintegrations@jdp.com.

Before moving on to finalize the set-up process, the JDP integration team will provide the following:    

  • Endpoint URL
  • Secret Key

Provide this information to your Greenhouse account executive and/or your Greenhouse implementation resource.

Additional resources

For additional information or troubleshooting not covered here, reach out tointegrationsupport@jdp.com.