Accurate Background provides background screening, drug testing, I-9 and occupational health services to help employers gain confidence in matching the right candidate to the right position at the right time.
Accurate’s ACCEL platform integration with Greenhouse Recruiting allows your organization to add an Accurate Background check to a job's interview pipeline.
Create a Harvest API key
To configure the 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 Accurate ACCEL integration.
Credentials
In the Create New Credential box, make the following selections:
- API Type: Harvest
- Partner: Accurate Background
- Description: Accurate Background Harvest API Key
Permissions
Verify that the following permissions are selected for the Accurate ACCEL integration:
-
Activity Feed:
- Get: Retrieve Application
-
Applications:
- Get: List Applications
- Patch: Update Application
-
Candidates
- Get: Retrieve Candidate
- Get: List Candidates
- Patch: Edit Candidate
- Post: Add Note
-
Custom Field Options:
- Get: Custom field options
-
Custom Fields:
- Get: Get custom fields
-
Jobs
- Get: Retrieve Job
- Get: List Jobs
- Get: Get hiring team
-
Offers:
- Get: Retrieve Offer
- Get: List Offers
-
User Roles
- Get: List User Roles
-
Users
- Get: Retrieve User
- Get: List Users
Field Mapping
| Available Fields | Greenhouse JSON Service | Greenhouse JSON Service/Path |
|---|---|---|
| Request Information | ||
| Client Reference Number | Webhook | candidateId:jobId |
| Company Code/ID | Webhook | job/custom_fields/greenhouse_company/value |
| Package Code/ID | Webhook | job/custom_fields/greenhouse_package/value |
| Requestor Email | Webhook | Recruiter/email |
| Position Location Information | ||
| Position State | GET: Retrieve Job | offices/location/name |
| Position Country | GET: Retrieve Job | offices/location/name |
| Position Postal Code/Zip code | not provided | not provided |
| Billing Code Information | ||
| Billing Code 1 | GET: Retrieve Job | job/custom_fields/ accurate_billing_code_1/value |
| Billing Code 2 | GET: Retrieve Job | job/custom_fields/ accurate_billing_code_2/value |
| Billing Code 3 | GET: Retrieve Job | job/custom_fields/ accurate_billing_code_3/value |
| Billing Code 4 | GET: Retrieve Job | job/custom_fields/ accurate_billing_code_4/value |
| Candidate Information | ||
| Candidate First Name | GET: Retrieve Candidate | first_name |
| Candidate Middle Name | GET: Retrieve Candidate | middle_name |
| Candidate Last Name | GET: Retrieve Candidate | last_name |
| Candidate Address 1 | GET: Retrieve Candidate | addresses/value |
| Candidate Address 2 | GET: Retrieve Candidate | addresses/value |
| Candidate Address 3 | GET: Retrieve Candidate | addresses/value |
| Candidate City | GET: Retrieve Candidate | addresses/value |
| Candidate State | GET: Retrieve Candidate | addresses/value |
| Candidate Country | GET: Retrieve Candidate | addresses/value |
| Candidate Postal Code/Zip Code | GET: Retrieve Candidate | addresses/value |
| Candidate Phone | GET: Retrieve Candidate | phone_numbers/value |
| Candidate Email | GET: Retrieve Candidate | email_addresses/value |
| Employment Information | ||
| Employer Name | GET: Retrieve Candidate | employments/company_name |
| Position History Position | GET: Retrieve Candidate | employments/title |
| Position History Employed From | GET: Retrieve Candidate | employments/start_date |
| Position History Employed To | GET: Retrieve Candidate | employments/end_date |
| Education Information | ||
| School Name | GET: Retrieve Candidate | educations/school_name |
| School Start Date | GET: Retrieve Candidate | educations/degree/start_date |
| School End Date | GET: Retrieve Candidate | educations/degree/end_date |
| Degree | GET: Retrieve Candidate | educations/degree |
| Major | GET: Retrieve Candidate | educations/discipline |
Create a webhook
To integrate Accurate ACCEL with Greenhouse Recruiting, you’ll need to create a webhook. Follow the steps in this article to create your webhook. Use the values listed below to configure the webhook:
- Name: Accurate ACCEL Integration
- When: Candidate has been hired
- Endpoint URL:
Create custom fields
Next, in order to use the Accurate ACCEL integration, you'll need to create a custom fields in Greenhouse Recruiting.
To create a custom Job field, click the Configure icon on your navigation bar, then click Custom Options on the left.
- From the resulting options, select “Jobs”:
- Select “Add Field”:
- Add the following information to create the Company field:
- Field Name: Greenhouse_Company
- Field Description: Select the background investigation company code
- Field Type: Single select
- Options: (input the list of provided companies, each on a new line—please note this may be only a single company code)
- Mark Required: Checked
- Select “Save” when completed to save changes
- Repeat the “Add Field” step to create the next custom field and add the following information to create the Package field:
- Field Name: Greenhouse_Package
- Field Description: Select the background investigation package
- Field Type: Single select
- Options: (input the list of provided packages, each on a new line)
- Mark Required: Checked
- Select “Save” when completed to save changes
- Repeat the “Add Field” step to create the next custom field and add the following information to create the Billing Code field(s). Please note that not all clients utilize billing codes within Accurate. IF billing codes are in scope for the account configuration, then the applicable field(s) should be added in Greenhouse.
- Field Name: Accurate Billing Code 1
- Field Description: Select the background investigation Billing Code. Please note that any text can be included here in place of ‘Billing Code’ to better instruct the user. For example, the text could read, ‘Select the background investigation department’ or ‘Select the background investigation location’, depending on what billing codes are in scope for the account configuration.
- Field Type: Single select
- Options: (input the list of provided billing codes, each on a new line)
- Mark Required: Checked (if all orders should have an applicable value—if not, then this can be an optional field)
- Repeat the “Add Field” step to create any additional billing code fields (up to four are supported):
- Accurate Billing Code 1
- Accurate Billing Code 2
- Accurate Billing Code 3
- Accurate Billing Code 4
Please see below for an example of the custom fields created at the job level in relation to package, company, and billing codes:
To learn more about creating custom job fields, check out this article.
Use the integration
Initiating the Background Request
Initiating the background check request is dependent on the webhook event - in this case, the “Candidate has been hired” event.
- Select “Move Stage”
- Select Offer
- Select “Mark as Hired”
- Select mandatory fields “opening and “close reason” and Select Save.
- Once candidate is marked as hired, the webhook will be triggered and check will be sent.
Status Updates/Results
Subsequent status update will be sent to Greenhouse activity feed as the order progresses through the Accurate platform:
- ‘Candidate InProgress’ will be sent when the request is initiated, and an invitation is sent to the Candidate.
- ‘In Progress’ will be sent after the Candidate completes their portion in Accurate’s Candidate Portal and fulfillment of the order begins. This is accompanied by a Result URL to view the order in AccurateAccel as it is being processed.
- ‘Complete’ will be sent when the order is completed in AccurateAccel.
- ‘Cancelled will be sent if the order is cancelled in AccurateAccel.
- Please note that Accurate could send an ‘In Progress’ status AFTER the order has been completed if the order is reopened for any reason.
Frequently asked questions
Can I use a webhook event outside of “Candidate has been hired”?
While Accurate recommends using this event as it normally occurs a single time in the workflow and requires less configuration, Accurate can support the use of additional events. Please connect with Accurate for details.
What do I do if I receive an error when testing a background investigation submission for a candidate?
If you receive any error messages (i.e., Duplicate, Missing Requestor, etc.), please notify your Accurate Background contact immediately. Providing screenshots, specific error messages, and timing is extremely helpful. We will investigate, determine the reason for the error, and work with you on the necessary corrective action(s).
Will I see actual data in when testing in the lower environment (UAT)?
No, we ask that all candidates submitted in the lower environments use test information (i.e., Mickey Mouse). Similarly, when completing the background investigations and sending updates back to Greenhouse, you may see generic data for some of the components in the result itself while you may not see any data for other components (i.e., crim searches). This is normal because of limited access to our lower environments by design.
Can the candidate’s personally identifiable information such as SSN or DOB be sent from Accurate Background to Greenhouse after the completion of the background investigation?
At this time, no. Accurate does not currently support sending Candidate related updates outside of updates to the Activity Feed described above.
Additional resources
For additional information or troubleshooting not covered here, reach out to ATSProduct@accurate.com.