> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Eploy Background Check Partner Integration

> Learn how to set up and use the Eploy Background Check as a Partner Integration with StackOne

## Overview

This guide explains how to configure custom options and fields, add background check packages in Eploy, and integrate with StackOne to receive background check notifications.

## Partner Requirements

Eploy integration partnership is required to proceed with this documentation. Visit [Eploy Technology Partner Support](https://www.eploy.com/partner/technology-partners) to fill out the form and initiate the partnership process. One of the Eploy team members will reach out to you to discuss the partnership and integration process.

### Eploy Approach: Workflow-based Integrations

Eploy enables workflow-based integrations for recruitment, handling tasks like background checks.
The process begins by regularly polling Eploy to identify applicants needing processing. Their data is then extracted to initiate the integration,
which includes creating actions and marking exported applications.

A typical Eploy workflow is structured as follows:

<Frame>
  <img src="https://mintcdn.com/stackone-60/6Q7CVU79dQffUr-h/images/eploy/background-check/eploy_bc_assess_process_flow_diagram_4.png?fit=max&auto=format&n=6Q7CVU79dQffUr-h&q=85&s=638ca93832ba5dc2de9057324b62047d" alt="eploy process flow" width="335" height="656" data-path="images/eploy/background-check/eploy_bc_assess_process_flow_diagram_4.png" />
</Frame>

### StackOne's Unified Approach for Integration Partners

StackOne manages the Eploy-required polling internally. The interaction model for this integration follows our standard webhook-based Background Check pattern.
Because Eploy requires polling, there can be a short delay between moving an application into the background check stage and the order being triggered.

<Info>
  **Note:** Repeating the following step is required for each user that you want to connect with Eploy.

  To add your background check integration, please contact [**Eploy Technology Partner Support**](https://www.eploy.com/partner/technology-partners)
</Info>

After your integration app is added as a stage in Eploy, configure the same stage name in StackOne as outlined in the following [steps](#stackone-configuration).

<Frame>
  <img src="https://mintcdn.com/stackone-60/6Q7CVU79dQffUr-h/images/eploy/background-check/eploy_bc_assess_process_sequence_diagram_7.png?fit=max&auto=format&n=6Q7CVU79dQffUr-h&q=85&s=7d8b0e46953e14213dfd3bd7ad9302bd" alt="stackone sequence flow" width="832" height="925" data-path="images/eploy/background-check/eploy_bc_assess_process_sequence_diagram_7.png" />
</Frame>

## Provider Side Setup

Once the Eploy partnership is established, your Eploy integration app will appear in the [Eploy Marketplace](https://www.eploy.com/product/eploy-marketplace).
After it is enabled for testing, the integration app will be available as a stage option in the Stages dropdown when creating or editing Recruiting Workflows.

<Note>
  Visit the [ATS User Experience](#ats-user-experience) section to be ensure that the integration app is enabled and visible as a stage in a Recruiting Workflow.
</Note>

<Frame>
  <img src="https://mintcdn.com/stackone-60/6Q7CVU79dQffUr-h/images/eploy/background-check/eploy_workflow_add_stage.png?fit=max&auto=format&n=6Q7CVU79dQffUr-h&q=85&s=f5a56c8247211138c23145d785fc3f48" alt="Eploy Integration app Stage" width="896" height="459" data-path="images/eploy/background-check/eploy_workflow_add_stage.png" />
</Frame>

<Note>
  Users must contact you or Eploy to activate the integration partnership. Once activated, your app appears in the Stages dropdown when users create or edit Recruiting Workflows.
</Note>

### Add a custom option for background check packages

Navigate to the *Custom Fields* page by selecting *Customise Fields* from the *Admin* menu

<Frame>
  <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="Go to Custom Fields page" src="https://mintcdn.com/stackone-60/6Q7CVU79dQffUr-h/images/eploy/background-check/eploy_bc_admin_custom_1.png?fit=max&auto=format&n=6Q7CVU79dQffUr-h&q=85&s=8e31a89ee4e0d13b4f3e4d8f70e12c80" width="328" height="215" data-path="images/eploy/background-check/eploy_bc_admin_custom_1.png" />
</Frame>

Navigate to the *User Option Types* tab and click the `New` button to create a new custom option in Eploy

<Frame>
  <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="Go to user option types tab" src="https://mintcdn.com/stackone-60/6Q7CVU79dQffUr-h/images/eploy/background-check/eploy_bc_navigate_to_user_option_type_and_new_2.png?fit=max&auto=format&n=6Q7CVU79dQffUr-h&q=85&s=eb032cd1c6e10ded0d616ad411b04693" width="331" height="167" data-path="images/eploy/background-check/eploy_bc_navigate_to_user_option_type_and_new_2.png" />
</Frame>

Enter the title as `Background Checks` and then click the `Save` button

<Warning>
  Use the name **Background Checks**, as this is necessary to ensure that you receive notifications from Eploy.
</Warning>

<Frame>
  <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="add custom option title" src="https://mintcdn.com/stackone-60/6Q7CVU79dQffUr-h/images/eploy/background-check/eploy_bc_user_option_type_4.png?fit=max&auto=format&n=6Q7CVU79dQffUr-h&q=85&s=638d18cecfd5da4ce33dae2967dbb6aa" width="658" height="363" data-path="images/eploy/background-check/eploy_bc_user_option_type_4.png" />
</Frame>

The newly created `Background Checks` option will be visible in the *User Option Types* grid

<Frame>
  <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="added custom option title" src="https://mintcdn.com/stackone-60/6Q7CVU79dQffUr-h/images/eploy/background-check/eploy_bc_user_option_type_newly_added_5.png?fit=max&auto=format&n=6Q7CVU79dQffUr-h&q=85&s=0e50072093495cae741c29cd808a611d" width="927" height="257" data-path="images/eploy/background-check/eploy_bc_user_option_type_newly_added_5.png" />
</Frame>

### Add a custom field within the vacancy group

Navigate to the *Custom Fields* page by selecting *Customise Fields* from the *Admin* menu

<Frame>
  <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="Go to Custom Fields page" src="https://mintcdn.com/stackone-60/6Q7CVU79dQffUr-h/images/eploy/background-check/eploy_bc_admin_custom_1.png?fit=max&auto=format&n=6Q7CVU79dQffUr-h&q=85&s=8e31a89ee4e0d13b4f3e4d8f70e12c80" width="328" height="215" data-path="images/eploy/background-check/eploy_bc_admin_custom_1.png" />
</Frame>

Navigate to the *Fields* tab and click the `New` > `Input Field` button to create a new input field in Eploy

<Frame>
  <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="Go to fields tab" src="https://mintcdn.com/stackone-60/6Q7CVU79dQffUr-h/images/eploy/background-check/eploy_bc_add_custom_field_3.png?fit=max&auto=format&n=6Q7CVU79dQffUr-h&q=85&s=a0f79690c9c48770017214f26fb20b14" width="321" height="158" data-path="images/eploy/background-check/eploy_bc_add_custom_field_3.png" />
</Frame>

Select the field values according to the instructions below:

<Warning>
  Ensure you select the same values as suggested to receive Eploy notifications.
</Warning>

* **Field Group:** Select `Additional Details (Vacancies)`
* **Field Type:** Select `Input - Drop-down`
* **Display Format:** Select `Hierarchy List Searchable`
* **Option Type:** Select `Background Checks` (as created in the [previous step](#add-a-custom-option-for-background-check-packages))
* **Insert Below:** You can select any value here; it will determine where the field appears in the form
* **Active:** Ensure this field is marked as **active**
* **Field Label:** Select `Background Checks`
* **Help Description:** You may include any relevant description

Click the `Save` button

<Frame>
  <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="add custom field" src="https://mintcdn.com/stackone-60/6Q7CVU79dQffUr-h/images/eploy/background-check/eploy_bc_create_new_field_within_the_vacancy_group_as_dropdown_9.png?fit=max&auto=format&n=6Q7CVU79dQffUr-h&q=85&s=0ac024a22c1bd265303dc817666f4958" width="892" height="911" data-path="images/eploy/background-check/eploy_bc_create_new_field_within_the_vacancy_group_as_dropdown_9.png" />
</Frame>

The newly created `Background Checks` field will be visible in the *Fields* grid

<Frame>
  <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="added custom field title" src="https://mintcdn.com/stackone-60/6Q7CVU79dQffUr-h/images/eploy/background-check/eploy_bc_new_field_will_be_visible_within_the_grid_10.png?fit=max&auto=format&n=6Q7CVU79dQffUr-h&q=85&s=62afaca215f7d5849e241e969d0bd7a4" width="855" height="262" data-path="images/eploy/background-check/eploy_bc_new_field_will_be_visible_within_the_grid_10.png" />
</Frame>

### Add background check packages

<Info>
  You can use the [Create Background Check Package](https://docs.stackone.com/ats/api-reference/background-checks/packages/create-background-check-package) unified endpoint to add background check packages, or follow the steps outlined below to add them manually.
</Info>

Navigate to the *Drop Down Lists* page located in the *Admin* menu to add background check packages through the Eploy user interface

<Frame>
  <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="navigate to dropdown list" src="https://mintcdn.com/stackone-60/6Q7CVU79dQffUr-h/images/eploy/background-check/eploy_bc_navigate_to_dropdown_list_17.png?fit=max&auto=format&n=6Q7CVU79dQffUr-h&q=85&s=570d6b4689e8be5b44e0d438fe12cbbf" width="203" height="166" data-path="images/eploy/background-check/eploy_bc_navigate_to_dropdown_list_17.png" />
</Frame>

Select `Background Checks` and click the `New` button to create a new package in Eploy

<Frame>
  <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="select background checks" src="https://mintcdn.com/stackone-60/6Q7CVU79dQffUr-h/images/eploy/background-check/eploy_bc_select_bc_from_dropdown_and_click_on_new_to_add_package_manually_from_ui_6.png?fit=max&auto=format&n=6Q7CVU79dQffUr-h&q=85&s=c8cbb284a50c100d04c9f96fcb5a6c48" width="758" height="112" data-path="images/eploy/background-check/eploy_bc_select_bc_from_dropdown_and_click_on_new_to_add_package_manually_from_ui_6.png" />
</Frame>

Enter the following field values:

* **Description:** This will be the label displayed in the dropdown list.
* **Reference:** This can be any string and will not appear in the dropdown list.

Click the `Save` button.

<Frame>
  <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="click on save" src="https://mintcdn.com/stackone-60/6Q7CVU79dQffUr-h/images/eploy/background-check/eploy_bc_add_bc_package_and_save_7.png?fit=max&auto=format&n=6Q7CVU79dQffUr-h&q=85&s=b583caa7a5b660dc825ad24a4d009da3" width="681" height="392" data-path="images/eploy/background-check/eploy_bc_add_bc_package_and_save_7.png" />
</Frame>

The newly created background check package will be visible in the grid

<Frame>
  <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="added background checks field" src="https://mintcdn.com/stackone-60/6Q7CVU79dQffUr-h/images/eploy/background-check/eploy_bc_added_new_package_and_visible_on_grid_8.png?fit=max&auto=format&n=6Q7CVU79dQffUr-h&q=85&s=8e1cf5441b884a2c9aa55281a29d2447" width="596" height="212" data-path="images/eploy/background-check/eploy_bc_added_new_package_and_visible_on_grid_8.png" />
</Frame>

### Configure the background check package for the vacancy

<Info>
  Users will need to select the background check package for each vacancy to associate the relevant background check.
</Info>

Go to the *Additional Details* page for job vacancies created within the Recruitment Workflow that includes the background check integration stage.

<Note>
  Visit the [ATS User Experience](#ats-user-experience) section to see how to create a vacancy in a workflow that includes the background check integration stage.
</Note>

<Frame>
  <img src="https://mintcdn.com/stackone-60/rZ0B-yBpLLj9Hd1m/images/eploy/background-check/eploy_navigate_to_additional_details_page_of_vacancy.png?fit=max&auto=format&n=rZ0B-yBpLLj9Hd1m&q=85&s=73784481ea8858fdaae07065e87ef71f" alt="Eploy navigate to additional details page of vacancy" width="1300" height="633" data-path="images/eploy/background-check/eploy_navigate_to_additional_details_page_of_vacancy.png" />
</Frame>

Edit *Additional Details* to select the background check package.

<Frame>
  <img src="https://mintcdn.com/stackone-60/rZ0B-yBpLLj9Hd1m/images/eploy/background-check/eploy_edit_additional_details.png?fit=max&auto=format&n=rZ0B-yBpLLj9Hd1m&q=85&s=309cff89fad6b3a4e6dfe9eadfa8cc56" alt="Eploy navigate to additional details page of vacancy" width="884" height="592" data-path="images/eploy/background-check/eploy_edit_additional_details.png" />
</Frame>

The selected background check package will be displayed on the *Additional Details* page.

<Frame>
  <img src="https://mintcdn.com/stackone-60/rZ0B-yBpLLj9Hd1m/images/eploy/background-check/eploy_selected_bc_visible_on_vacnacy_page.png?fit=max&auto=format&n=rZ0B-yBpLLj9Hd1m&q=85&s=10c9549334d6b1bff934a30d1d31744d" alt="Eploy selected background check package" width="1108" height="629" data-path="images/eploy/background-check/eploy_selected_bc_visible_on_vacnacy_page.png" />
</Frame>

## StackOne Configuration

<Steps>
  <Step title="Navigate to enable Eploy in StackOne">
    Go to the ATS category on the *Integrations* page and find Eploy.

    <Frame>
      <img src="https://mintcdn.com/stackone-60/6Q7CVU79dQffUr-h/images/eploy/background-check/eploy_bc_assess_enable_1.png?fit=max&auto=format&n=6Q7CVU79dQffUr-h&q=85&s=d7ec168fe4de90a8c60b28f46276df6c" alt="enable eploy" width="1679" height="470" data-path="images/eploy/background-check/eploy_bc_assess_enable_1.png" />
    </Frame>
  </Step>

  <Step title="Configure Eploy in StackOne">
    Fill out the necessary fields in the **Eploy - Configuration** modal:

    * **Authentication Type:** Select `OAuth2`.
    * **Integration Stage Name:** Enter the stage name exactly as your integration app's stage name in Eploy to trigger the Background Check.

    <Frame>
      <img src="https://mintcdn.com/stackone-60/6Q7CVU79dQffUr-h/images/eploy/background-check/eploy_bc_assess_config_form.png?fit=max&auto=format&n=6Q7CVU79dQffUr-h&q=85&s=8ff716d93bf1857c5cbdab4bdb924e31" alt="configure eploy" width="670" height="595" data-path="images/eploy/background-check/eploy_bc_assess_config_form.png" />
    </Frame>

    Click `Confirm` or `Save Changes` to enable your OAuth APIs, which allows end-users to link their accounts via the Hub.
  </Step>

  <Step title="Add a Webhook">
    Navigate to the *Webhooks* page, click `Add webhook`, and fill out the form:

    * **Name:** A recognisable name for the webhook.
    * **URL:** The endpoint that will receive notifications for enabled events.

    <Frame>
      <img src="https://mintcdn.com/stackone-60/6Q7CVU79dQffUr-h/images/eploy/background-check/eploy_add_webhook.png?fit=max&auto=format&n=6Q7CVU79dQffUr-h&q=85&s=b13e9f36e01cb58d32113fd54af5d910" alt="Add Webhook form" width="534" height="387" data-path="images/eploy/background-check/eploy_add_webhook.png" />
    </Frame>

    Enable webhook events in the `Events` tab for Background Check, such as `Background Check Order`.

    <Frame>
      <img src="https://mintcdn.com/stackone-60/6Q7CVU79dQffUr-h/images/eploy/background-check/eploy_webhook_event.png?fit=max&auto=format&n=6Q7CVU79dQffUr-h&q=85&s=f8ab29edb2c1befd286485702495824d" alt="Select webhook events" width="1856" height="1097" data-path="images/eploy/background-check/eploy_webhook_event.png" />
    </Frame>

    Click `Confirm` and then `Save` to add the webhook.
  </Step>
</Steps>

## ATS User Enablement

To enable the Eploy Technology Partner app and make it available as a stage within a Recruitment Workflow, go to the [Eploy Marketplace](https://www.eploy.com/product/eploy-marketplace).

<Frame>
  <img src="https://mintcdn.com/stackone-60/6Q7CVU79dQffUr-h/images/eploy/background-check/eploy_marketplace.png?fit=max&auto=format&n=6Q7CVU79dQffUr-h&q=85&s=269be27e77a1d7341ba68897ecc868e7" alt="Eploy Marketplace" width="1603" height="929" data-path="images/eploy/background-check/eploy_marketplace.png" />
</Frame>

Click the listed partner's app in the Marketplace. It will direct you to the [Integrate your Eploy with Partner form](https://www.eploy.com/partner/technology-partners). Fill out the form to initiate your request to enable the integration for your Eploy account.

<Frame>
  <img src="https://mintcdn.com/stackone-60/6Q7CVU79dQffUr-h/images/eploy/background-check/eploy_marketplace_request_form.png?fit=max&auto=format&n=6Q7CVU79dQffUr-h&q=85&s=f40afdbce48455254de5875ff37977d5" alt="Eploy Marketplace" width="1561" height="641" data-path="images/eploy/background-check/eploy_marketplace_request_form.png" />
</Frame>

Once the partner's app is enabled, it appears in the Stages dropdown when creating or editing Recruitment Workflows.

<Note>
  Visit the [ATS User Experience](#ats-user-experience) section to verify if the partner's integration app is enabled and visible in the Stages dropdown.
</Note>

## ATS User Experience

### Add a Recruitment Workflow

Navigate to the *Recruitment Workflow* page from the *Admin* menu.

<Frame>
  <img src="https://mintcdn.com/stackone-60/rZ0B-yBpLLj9Hd1m/images/eploy/background-check/eploy_navigate_to_recruitment_workflow.png?fit=max&auto=format&n=rZ0B-yBpLLj9Hd1m&q=85&s=fbacc0e7774ada67cd36abfaff82c313" alt="Eploy Integration app Stage" width="250" height="433" data-path="images/eploy/background-check/eploy_navigate_to_recruitment_workflow.png" />
</Frame>

Click the `+ New` button to create a new workflow.

<Frame>
  <img src="https://mintcdn.com/stackone-60/rZ0B-yBpLLj9Hd1m/images/eploy/background-check/eploy_new_recruitment_workflow.png?fit=max&auto=format&n=rZ0B-yBpLLj9Hd1m&q=85&s=5a952b6f544bc890b197aab6e90aa93d" alt="Eploy Integration app Stage" width="235" height="147" data-path="images/eploy/background-check/eploy_new_recruitment_workflow.png" />
</Frame>

Fill out the necessary fields in the *Create Recruitment Workflow* form as per the requirements, and click `Save`.

<Frame>
  <img src="https://mintcdn.com/stackone-60/rZ0B-yBpLLj9Hd1m/images/eploy/background-check/eploy_create_recruitment_workflow_form.png?fit=max&auto=format&n=rZ0B-yBpLLj9Hd1m&q=85&s=d5aa0c50438caa136beed4da2713ed26" alt="Eploy Integration app Stage" width="910" height="397" data-path="images/eploy/background-check/eploy_create_recruitment_workflow_form.png" />
</Frame>

Scroll down and click the `Add` button to add stages in the workflow.

<Frame>
  <img src="https://mintcdn.com/stackone-60/rZ0B-yBpLLj9Hd1m/images/eploy/background-check/eploy_add_stage_button.png?fit=max&auto=format&n=rZ0B-yBpLLj9Hd1m&q=85&s=fbcb01878d8724fc781f0916bb0e6753" alt="Eploy Integration app Stage" width="891" height="467" data-path="images/eploy/background-check/eploy_add_stage_button.png" />
</Frame>

User can choose various stages as per the requirements and select the partner's integration app stage from the Stages dropdown to trigger the background check notification.

For the partner's integration app stage, select the following values:

* **Stage Name:** Select the partner's integration app name.

<Frame>
  <img src="https://mintcdn.com/stackone-60/6Q7CVU79dQffUr-h/images/eploy/background-check/eploy_workflow_add_stage.png?fit=max&auto=format&n=6Q7CVU79dQffUr-h&q=85&s=f5a56c8247211138c23145d785fc3f48" alt="Eploy Integration app Stage" width="896" height="459" data-path="images/eploy/background-check/eploy_workflow_add_stage.png" />
</Frame>

* **Stage Type:** Select `Actions`.
* **Action Type:** Select the partner's integration app name.

User may configure other settings as per the requirements and click `Save` to add this stage to the workflow.

<Frame>
  <img src="https://mintcdn.com/stackone-60/rZ0B-yBpLLj9Hd1m/images/eploy/background-check/eploy_add_integration_stage.png?fit=max&auto=format&n=rZ0B-yBpLLj9Hd1m&q=85&s=5860a16f821a7d7e64dcc945d14865a9" alt="Eploy Integration app Stage" width="891" height="423" data-path="images/eploy/background-check/eploy_add_integration_stage.png" />
</Frame>

After saving, the stage appears in the workflow.

<Frame>
  <img src="https://mintcdn.com/stackone-60/rZ0B-yBpLLj9Hd1m/images/eploy/background-check/eploy_stage_appear_in_the_workflow.png?fit=max&auto=format&n=rZ0B-yBpLLj9Hd1m&q=85&s=650a95917eb0473d4d1eba9110d9e3ad" alt="Eploy integration stage" width="859" height="1086" data-path="images/eploy/background-check/eploy_stage_appear_in_the_workflow.png" />
</Frame>

Ensure the workflow is set to `Active` to be visible when creating a vacancy.

<Frame>
  <img src="https://mintcdn.com/stackone-60/rZ0B-yBpLLj9Hd1m/images/eploy/background-check/eploy_activate_workflow.png?fit=max&auto=format&n=rZ0B-yBpLLj9Hd1m&q=85&s=b2943671f0570a01945ed5211148997a" alt="Eploy activate workflow" width="897" height="410" data-path="images/eploy/background-check/eploy_activate_workflow.png" />
</Frame>

The newly created workflow appears in the *Recruitment Workflow* grid.

<Frame>
  <img src="https://mintcdn.com/stackone-60/KoApCCOhWig-ADCg/images/eploy/background-check/eploy_workflow_visible_in_grid.png?fit=max&auto=format&n=KoApCCOhWig-ADCg&q=85&s=0264c84034988e8caaf78cdb4dd28206" alt="Eploy saved workflow" width="512" height="336" data-path="images/eploy/background-check/eploy_workflow_visible_in_grid.png" />
</Frame>

### Create a Vacancy in the Workflow

Navigate to the *Vacancy* page via `+` button in the top menu.

<Frame>
  <img src="https://mintcdn.com/stackone-60/rZ0B-yBpLLj9Hd1m/images/eploy/background-check/eploy_vacancy_navigation.png?fit=max&auto=format&n=rZ0B-yBpLLj9Hd1m&q=85&s=9cbb6d60da43880853c3a8ce66beac5c" alt="Eploy navigate to vacancies" width="353" height="234" data-path="images/eploy/background-check/eploy_vacancy_navigation.png" />
</Frame>

Fill out the vacancy form by choosing the **Recruitment Workflow** that includes the partner's integration app stage user added earlier. User can also configure other fields as per the requirements and click `Save`.

<Frame>
  <img src="https://mintcdn.com/stackone-60/rZ0B-yBpLLj9Hd1m/images/eploy/background-check/eploy_create_vacancy.png?fit=max&auto=format&n=rZ0B-yBpLLj9Hd1m&q=85&s=6199d1ee591b837579821a8c0321637a" alt="Eploy create vacancy" width="910" height="464" data-path="images/eploy/background-check/eploy_create_vacancy.png" />
</Frame>

User will be directed to the vacancy page after saving.

<Frame>
  <img src="https://mintcdn.com/stackone-60/rZ0B-yBpLLj9Hd1m/images/eploy/background-check/eploy_created_vacancy_page.png?fit=max&auto=format&n=rZ0B-yBpLLj9Hd1m&q=85&s=bd1a07c600fd380c48e1c61d11ae6131" alt="Eploy create vacancy" width="766" height="451" data-path="images/eploy/background-check/eploy_created_vacancy_page.png" />
</Frame>

User can see the partner's integration app stage in the vacancy's talent pipeline by navigating to `Work on Vacancy` > `Go to Pipeline`.

<Frame>
  <img src="https://mintcdn.com/stackone-60/rZ0B-yBpLLj9Hd1m/images/eploy/background-check/eploy_navigate_to_vacancy_pipeline.png?fit=max&auto=format&n=rZ0B-yBpLLj9Hd1m&q=85&s=5ddd429db2b0f9b15d213074f9434ce5" alt="Eploy integration stage in talent pipeline" width="902" height="189" data-path="images/eploy/background-check/eploy_navigate_to_vacancy_pipeline.png" />
</Frame>

The stage appears in the vacancy's talent pipeline.

<Frame>
  <img src="https://mintcdn.com/stackone-60/KoApCCOhWig-ADCg/images/eploy/background-check/eploy_vacancy_stage_appears.png?fit=max&auto=format&n=KoApCCOhWig-ADCg&q=85&s=ce646896fb3022795e2d80c4c915b575" alt="Eploy integration stage in talent pipeline" width="1161" height="225" data-path="images/eploy/background-check/eploy_vacancy_stage_appears.png" />
</Frame>

### Select a Background Check package to associate with the vacancy

Navigate to the *Additional Details* page of the vacancy to select and associate the background check package.

<Frame>
  <img src="https://mintcdn.com/stackone-60/rZ0B-yBpLLj9Hd1m/images/eploy/background-check/eploy_navigate_to_additional_details_page_of_vacancy.png?fit=max&auto=format&n=rZ0B-yBpLLj9Hd1m&q=85&s=73784481ea8858fdaae07065e87ef71f" alt="Eploy navigate to additional details page of vacancy" width="1300" height="633" data-path="images/eploy/background-check/eploy_navigate_to_additional_details_page_of_vacancy.png" />
</Frame>

Edit the *Additional Details*, select the background check package from the `Background Checks` dropdown, and `Save` the changes.

<Frame>
  <img src="https://mintcdn.com/stackone-60/rZ0B-yBpLLj9Hd1m/images/eploy/background-check/eploy_edit_additional_details.png?fit=max&auto=format&n=rZ0B-yBpLLj9Hd1m&q=85&s=309cff89fad6b3a4e6dfe9eadfa8cc56" alt="Eploy select background check package" width="884" height="592" data-path="images/eploy/background-check/eploy_edit_additional_details.png" />
</Frame>

The selected background check package will appear on the *Additional Details* page.

<Frame>
  <img src="https://mintcdn.com/stackone-60/rZ0B-yBpLLj9Hd1m/images/eploy/background-check/eploy_selected_bc_visible_on_vacnacy_page.png?fit=max&auto=format&n=rZ0B-yBpLLj9Hd1m&q=85&s=10c9549334d6b1bff934a30d1d31744d" alt="Eploy selected background check package" width="1108" height="629" data-path="images/eploy/background-check/eploy_selected_bc_visible_on_vacnacy_page.png" />
</Frame>

### Create a Candidate and add as an applicant to the vacancy

Navigate to the *Candidate* page via `+` button in the top menu.

<Frame>
  <img src="https://mintcdn.com/stackone-60/rZ0B-yBpLLj9Hd1m/images/eploy/background-check/eploy_navigate_to_candidates.png?fit=max&auto=format&n=rZ0B-yBpLLj9Hd1m&q=85&s=10bf966f43f229163c18aa24f3e6ef69" alt="Eploy navigate to candidates" width="264" height="305" data-path="images/eploy/background-check/eploy_navigate_to_candidates.png" />
</Frame>

Fill out the necessary details in the **Create Candidate** form and `Save`.

<Frame>
  <img src="https://mintcdn.com/stackone-60/rZ0B-yBpLLj9Hd1m/images/eploy/background-check/eploy_create_candidate_form.png?fit=max&auto=format&n=rZ0B-yBpLLj9Hd1m&q=85&s=d7b8641b2e4ad3764a848deac310d607" alt="Eploy create candidate" width="895" height="1010" data-path="images/eploy/background-check/eploy_create_candidate_form.png" />
</Frame>

User will be directed to the candidate's profile page after saving, where they can initiate the candidate's application by clicking `Application` under the `+` button menu.

<Frame>
  <img src="https://mintcdn.com/stackone-60/rZ0B-yBpLLj9Hd1m/images/eploy/background-check/eploy_candidate_created_and_apply_to_vacancy.png?fit=max&auto=format&n=rZ0B-yBpLLj9Hd1m&q=85&s=cbbbd3dd007bea4f5c871808202fa7ce" alt="Eploy create vacancy" width="1061" height="452" data-path="images/eploy/background-check/eploy_candidate_created_and_apply_to_vacancy.png" />
</Frame>

Select the **Vacancy** and **Stage**, and then `Save` to add the candidate as an applicant to the vacancy.

<Frame>
  <img src="https://mintcdn.com/stackone-60/rZ0B-yBpLLj9Hd1m/images/eploy/background-check/eploy_create_application_form.png?fit=max&auto=format&n=rZ0B-yBpLLj9Hd1m&q=85&s=4b8efb54177bd9ba9c9d255d3d789b38" alt="Eploy apply to vacancy" width="893" height="276" data-path="images/eploy/background-check/eploy_create_application_form.png" />
</Frame>

User can see the candidate added as an applicant to the vacancy by navigating to the vacancy's talent pipeline.

<Frame>
  <img src="https://mintcdn.com/stackone-60/rZ0B-yBpLLj9Hd1m/images/eploy/background-check/eploy_navigate_to_vacancy_pipeline.png?fit=max&auto=format&n=rZ0B-yBpLLj9Hd1m&q=85&s=5ddd429db2b0f9b15d213074f9434ce5" alt="Eploy candidate added to vacancy" width="902" height="189" data-path="images/eploy/background-check/eploy_navigate_to_vacancy_pipeline.png" />
</Frame>

The candidate appears in the **Stage** user selected when creating the application.

<Frame>
  <img src="https://mintcdn.com/stackone-60/rZ0B-yBpLLj9Hd1m/images/eploy/background-check/eploy_candidate_in_pipeline.png?fit=max&auto=format&n=rZ0B-yBpLLj9Hd1m&q=85&s=b8455221515e4e77d83c3b1affa5a1b7" alt="Eploy candidate in pipeline" width="927" height="554" data-path="images/eploy/background-check/eploy_candidate_in_pipeline.png" />
</Frame>

User can move the candidate's application to the partner's integration app stage to trigger the background check.

<Note>
  Because Eploy requires polling, there can be a short delay between moving an application into the background check stage and the order being triggered.
</Note>

### Send test to the candidate

<Frame caption="Test your integration with StackOne using your Eploy Sandbox">
  <video controls className="w-full aspect-video" src="https://cdn.stackone.com/public/eploy_background_checks_order_and_update_result.mov" />
</Frame>

### User will see after test has been sent

When a user sends the background check test to a candidate, a success message is shown on the candidate's application.

<Frame>
  <img src="https://mintcdn.com/stackone-60/rZ0B-yBpLLj9Hd1m/images/eploy/background-check/eploy_bc_sent_to_the_candidate_as_visible_package_name_on_ui.png?fit=max&auto=format&n=rZ0B-yBpLLj9Hd1m&q=85&s=6bf512adabdc81d476c53cf67a0a1a87" alt="Eploy sent test view" width="1186" height="443" data-path="images/eploy/background-check/eploy_bc_sent_to_the_candidate_as_visible_package_name_on_ui.png" />
</Frame>

## ATS User Experience Customisation

<Steps>
  <Step title="Update the result via Unified API">
    Use the following endpoint to update the results:

    * [Background Check Update Result](https://docs.stackone.com/ats/api-reference/background-checks/results/update-background-check-result)

    Use the following endpoint to get metadata needed to update the background check result:

    * [Connector Meta Information](https://docs.stackone.com/platform/api-reference/connectors/get-connector-meta-information) with the provider key `eploy` for model `background_checks/results.update`

    <div className="fields-table">
      | Fields (when provided) | User sees in Eploy                                                 |
      | ---------------------- | ------------------------------------------------------------------ |
      | Score label & value    | Score label and value will appear together in Eploy                |
      | Submission date        | Submission date will appear above or below the result detail block |
      | Summary                | Summary will appear above the package name                         |
      | Result URL             | Result URL will appear within the `View Results` link              |
    </div>
  </Step>

  <Step title="How will the results of the background check be displayed to the user in Eploy?">
    When a user opens a candidate application, the updated results are visible.

    <Frame>
      <img src="https://mintcdn.com/stackone-60/rZ0B-yBpLLj9Hd1m/images/eploy/background-check/eploy_bc_on_update_result_of_bc_on_ui.png?fit=max&auto=format&n=rZ0B-yBpLLj9Hd1m&q=85&s=7e59924d522298bfc3454fa907956489" alt="Eploy update result view" width="1191" height="951" data-path="images/eploy/background-check/eploy_bc_on_update_result_of_bc_on_ui.png" />
    </Frame>
  </Step>
</Steps>

## Testing Checklist

✅  **Provider Setup:**

* Ensure the Eploy Partner Integration app is enabled for your Eploy Sandbox account.
* Add the `Background Checks` custom option in User Option Types. See <a href="#add-a-custom-option-for-background-check-packages">this</a> step.
* Add a custom input field for the vacancy group; it appears under *Additional Details*. See <a href="#add-a-custom-field-within-the-vacancy-group">this</a> step.
* Add background check packages; they appear in the custom field dropdown. See <a href="#add-background-check-packages">this</a> step.
* Associate a background check package with the vacancy. See <a href="#configure-the-background-check-package-for-the-vacancy">this</a> step.

✅  **StackOne Configuration:**

* Enter a valid `Integration Stage Name` that exactly matches your integration app's stage name in Eploy.

✅  **ATS User Enablement:**

* The partner app is enabled by Eploy and visible in the Stages dropdown to add within a workflow.
* The user associates the background check package for the vacancy.

✅  **Create a Webhook:**

* Add a webhook for Eploy with a valid URL and enable expected Background Check events, such as `Background Check Order`.

✅  **ATS User Experience:**

* Go to *Vacancy* > *Additional Details* and select a background check package to associate with the vacancy.
* The integration stage is visible when the vacancy is created in a workflow that includes the background check stage.
  * The user can move the application to the integration stage.
  * The user can see the sent test details in the candidate's application.

✅  **Update Result:**

* Receive a success response from the update result endpoint.
* Updated result details appear in Eploy's UI.

## Troubleshooting

<div className="troubleshooting-table">
  | Symptom                                                                                                                 | Likely cause                                                                        | Fix                                                                                                                                                       |
  | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | Unable to find your Integration app in the [Eploy Marketplace](https://www.eploy.com/product/eploy-marketplace).        | Eploy Partner Integration is not published/approved.                                | Contact Eploy support for partnership status.                                                                                                             |
  | Integration partner app not visible under stage list dropdown.                                                          | Integration app is not active for your eploy account.                               | Contact Eploy support for partnership status.                                                                                                             |
  | Integration partner app not visible as a stage in vacancy pipeline.                                                     | Integration app is not selected as a stage in vacancy's workflow.                   | Navigate to vacancy's workflow and add integration as a stage. please refer to <a href="#ats-user-experience">this</a> steps.                             |
  | Unable to see the `Background Checks` custom field in Additional Details page of the vacancy.                           | Custom field is not created or configured incorrectly.                              | Create a custom field as per the instructions in the [Add a custom field within the vacancy group](#add-a-custom-field-within-the-vacancy-group) section. |
  | Unable to see the list of packages in the `Background Checks` dropdown field in Additional Details page of the vacancy. | Packages are not added for background checks custom fields.                         | Add background check packages as mentioned in the [Add background check packages](#add-background-check-packages) section.                                |
  | Test notification is not received.                                                                                      | **•** Invalid webhook URL. <br /><br /> **•** Incorrect webhook events are enabled. | **•** Verify webhook URL. <br /><br /> **•** Enable expected events as mentioned in the [StackOne Configuration](#stackone-configuration).                |
  | Unable to update result.                                                                                                | Invalid payload format.                                                             | Check Connector Meta API endpoint for payload format.                                                                                                     |
</div>

For persistent issues, contact StackOne support with detailed error logs and configuration information.
