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

# Eploy Background Check

> To successfully send webhook notifications from Eploy, follow these steps in your Eploy account, and complete the necessary actions.

<Warning>
  This guidance assumes that you have admin privileges for your Eploy account.
</Warning>

## Enable the Partner's Integration App in your Eploy account

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-hub/VECor-nT0Zr0Z2wh/images/eploy/assess-bcs/eploy_marketplace.png?fit=max&auto=format&n=VECor-nT0Zr0Z2wh&q=85&s=87428215a4d8e7b033255129c3487bcf" alt="Eploy Marketplace" width="1603" height="929" data-path="images/eploy/assess-bcs/eploy_marketplace.png" />
</Frame>

Click the partner's app in the Marketplace that you want to enable. 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 app.

<Frame>
  <img src="https://mintcdn.com/stackone-hub/VECor-nT0Zr0Z2wh/images/eploy/assess-bcs/eploy_marketplace_request_form.png?fit=max&auto=format&n=VECor-nT0Zr0Z2wh&q=85&s=e5c040cb68a60a1b87938a5753e214f1" alt="Eploy Marketplace" width="1561" height="641" data-path="images/eploy/assess-bcs/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 [Add a Recruitment Workflow](#add-a-recruitment-workflow) section to verify if the partner's integration app is enabled and visible in the Stages dropdown.
</Note>

## Add a Recruitment Workflow

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

<Frame>
  <img src="https://mintcdn.com/stackone-hub/VECor-nT0Zr0Z2wh/images/eploy/assess-bcs/eploy_navigate_to_recruitment_workflow.png?fit=max&auto=format&n=VECor-nT0Zr0Z2wh&q=85&s=8b870a695bd5018fedfc7e874c5b22c3" alt="Eploy Integration app Stage" width="250" height="433" data-path="images/eploy/assess-bcs/eploy_navigate_to_recruitment_workflow.png" />
</Frame>

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

<Frame>
  <img src="https://mintcdn.com/stackone-hub/VECor-nT0Zr0Z2wh/images/eploy/assess-bcs/eploy_new_recruitment_workflow.png?fit=max&auto=format&n=VECor-nT0Zr0Z2wh&q=85&s=17c2a9a238c5dd3dd575741ff5a69034" alt="Eploy Integration app Stage" width="235" height="147" data-path="images/eploy/assess-bcs/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-hub/VECor-nT0Zr0Z2wh/images/eploy/assess-bcs/eploy_create_recruitment_workflow_form.png?fit=max&auto=format&n=VECor-nT0Zr0Z2wh&q=85&s=a99f1a776cc61d878c7d3e167de2ac3f" alt="Eploy Integration app Stage" width="910" height="397" data-path="images/eploy/assess-bcs/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-hub/T_18jpVOl4zQtFdI/images/eploy/assess-bcs/eploy_add_stage_button.png?fit=max&auto=format&n=T_18jpVOl4zQtFdI&q=85&s=aa851be1ecdcf23405eb8e87b148ff90" alt="Eploy Integration app Stage" width="891" height="467" data-path="images/eploy/assess-bcs/eploy_add_stage_button.png" />
</Frame>

You 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.

<Warning>
  If your partner's integration app is enabled, it'll appear in the **Stages** dropdown such as `Your Integration Stage`, else contact Eploy support to enable the integration app.
</Warning>

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

You 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-hub/T_18jpVOl4zQtFdI/images/eploy/assess-bcs/eploy_add_integration_stage_hub.png?fit=max&auto=format&n=T_18jpVOl4zQtFdI&q=85&s=a862a3dd6f3c1c2f0300bdb74c066727" alt="Eploy Integration app Stage" width="886" height="449" data-path="images/eploy/assess-bcs/eploy_add_integration_stage_hub.png" />
</Frame>

After saving, the stage appears in the workflow.

<Frame>
  <img src="https://mintcdn.com/stackone-hub/VECor-nT0Zr0Z2wh/images/eploy/assess-bcs/eploy_stage_appear_in_the_workflow_hub.png?fit=max&auto=format&n=VECor-nT0Zr0Z2wh&q=85&s=a67a2ce48715951b10e7548377e64173" alt="Eploy integration stage" width="847" height="1151" data-path="images/eploy/assess-bcs/eploy_stage_appear_in_the_workflow_hub.png" />
</Frame>

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

<Frame>
  <img src="https://mintcdn.com/stackone-hub/T_18jpVOl4zQtFdI/images/eploy/assess-bcs/eploy_activate_workflow.png?fit=max&auto=format&n=T_18jpVOl4zQtFdI&q=85&s=b7382b41d5d8938bc2cf87f261771742" alt="Eploy activate workflow" width="897" height="410" data-path="images/eploy/assess-bcs/eploy_activate_workflow.png" />
</Frame>

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

<Frame>
  <img src="https://mintcdn.com/stackone-hub/VECor-nT0Zr0Z2wh/images/eploy/assess-bcs/eploy_workflow_visible_in_grid.png?fit=max&auto=format&n=VECor-nT0Zr0Z2wh&q=85&s=88cdf4407ae20478dfdb754948d0fbc5" alt="Eploy saved workflow" width="512" height="336" data-path="images/eploy/assess-bcs/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-hub/VECor-nT0Zr0Z2wh/images/eploy/assess-bcs/eploy_vacancy_navigation.png?fit=max&auto=format&n=VECor-nT0Zr0Z2wh&q=85&s=37b65bee16b893d9b04140c2ad929c59" alt="Eploy navigate to vacancies" width="353" height="234" data-path="images/eploy/assess-bcs/eploy_vacancy_navigation.png" />
</Frame>

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

<Frame>
  <img src="https://mintcdn.com/stackone-hub/VECor-nT0Zr0Z2wh/images/eploy/assess-bcs/eploy_create_vacancy.png?fit=max&auto=format&n=VECor-nT0Zr0Z2wh&q=85&s=e061fe4783e9d2b96f8426f7e69c0ba7" alt="Eploy create vacancy" width="910" height="464" data-path="images/eploy/assess-bcs/eploy_create_vacancy.png" />
</Frame>

You will be directed to the vacancy page after saving.

<Frame>
  <img src="https://mintcdn.com/stackone-hub/VECor-nT0Zr0Z2wh/images/eploy/assess-bcs/eploy_created_vacancy_page.png?fit=max&auto=format&n=VECor-nT0Zr0Z2wh&q=85&s=8526129eb6f04737c3a5ba17b47762c6" alt="Eploy create vacancy" width="766" height="451" data-path="images/eploy/assess-bcs/eploy_created_vacancy_page.png" />
</Frame>

You 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-hub/VECor-nT0Zr0Z2wh/images/eploy/assess-bcs/eploy_navigate_to_vacancy_pipeline.png?fit=max&auto=format&n=VECor-nT0Zr0Z2wh&q=85&s=d83c71456281c6bad59b670f76b9a604" alt="Eploy integration stage in talent pipeline" width="902" height="189" data-path="images/eploy/assess-bcs/eploy_navigate_to_vacancy_pipeline.png" />
</Frame>

The stage appears in the vacancy's talent pipeline.

<Frame>
  <img src="https://mintcdn.com/stackone-hub/VECor-nT0Zr0Z2wh/images/eploy/assess-bcs/eploy_vacancy_stage_appears_hub.png?fit=max&auto=format&n=VECor-nT0Zr0Z2wh&q=85&s=8dffdc43b2b8ed1389776a70f2c202fd" alt="Eploy integration stage in talent pipeline" width="646" height="245" data-path="images/eploy/assess-bcs/eploy_vacancy_stage_appears_hub.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-hub/VECor-nT0Zr0Z2wh/images/eploy/assess-bcs/eploy_navigate_to_additional_details_page_of_vacancy.png?fit=max&auto=format&n=VECor-nT0Zr0Z2wh&q=85&s=de4a602621876b6c01c697c897b4be3f" alt="Eploy navigate to additional details page of vacancy" width="1300" height="633" data-path="images/eploy/assess-bcs/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-hub/VECor-nT0Zr0Z2wh/images/eploy/assess-bcs/eploy_edit_additional_details.png?fit=max&auto=format&n=VECor-nT0Zr0Z2wh&q=85&s=906a7d93da966df5b0d64776b8e1930d" alt="Eploy select background check package" width="884" height="592" data-path="images/eploy/assess-bcs/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-hub/VECor-nT0Zr0Z2wh/images/eploy/assess-bcs/eploy_selected_bc_visible_on_vacnacy_page.png?fit=max&auto=format&n=VECor-nT0Zr0Z2wh&q=85&s=0a94ccf4ffa81986549e9b90e8ce526b" alt="Eploy selected background check package" width="1108" height="629" data-path="images/eploy/assess-bcs/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-hub/VECor-nT0Zr0Z2wh/images/eploy/assess-bcs/eploy_navigate_to_candidates.png?fit=max&auto=format&n=VECor-nT0Zr0Z2wh&q=85&s=e46f915d850e05b249dc1c6e17cf9950" alt="Eploy navigate to candidates" width="264" height="305" data-path="images/eploy/assess-bcs/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-hub/VECor-nT0Zr0Z2wh/images/eploy/assess-bcs/eploy_create_candidate_form.png?fit=max&auto=format&n=VECor-nT0Zr0Z2wh&q=85&s=80614ec82f7fdc1c393581ed9edee9da" alt="Eploy create candidate" width="895" height="1010" data-path="images/eploy/assess-bcs/eploy_create_candidate_form.png" />
</Frame>

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

<Frame>
  <img src="https://mintcdn.com/stackone-hub/VECor-nT0Zr0Z2wh/images/eploy/assess-bcs/eploy_candidate_created_and_apply_to_vacancy.png?fit=max&auto=format&n=VECor-nT0Zr0Z2wh&q=85&s=ff79b7eba46fde4673b0a6c26dc30e98" alt="Eploy create vacancy" width="1061" height="452" data-path="images/eploy/assess-bcs/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-hub/VECor-nT0Zr0Z2wh/images/eploy/assess-bcs/eploy_create_application_form.png?fit=max&auto=format&n=VECor-nT0Zr0Z2wh&q=85&s=aef684b80d2bab26eafe78f0bf593f9c" alt="Eploy apply to vacancy" width="893" height="276" data-path="images/eploy/assess-bcs/eploy_create_application_form.png" />
</Frame>

You 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-hub/VECor-nT0Zr0Z2wh/images/eploy/assess-bcs/eploy_navigate_to_vacancy_pipeline.png?fit=max&auto=format&n=VECor-nT0Zr0Z2wh&q=85&s=d83c71456281c6bad59b670f76b9a604" alt="Eploy candidate added to vacancy" width="902" height="189" data-path="images/eploy/assess-bcs/eploy_navigate_to_vacancy_pipeline.png" />
</Frame>

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

<Frame>
  <img src="https://mintcdn.com/stackone-hub/VECor-nT0Zr0Z2wh/images/eploy/assess-bcs/eploy_candidate_in_pipeline_hub.png?fit=max&auto=format&n=VECor-nT0Zr0Z2wh&q=85&s=cc3062ddc231fb59447c1cc8c27b7ffb" alt="Eploy candidate in pipeline" width="646" height="416" data-path="images/eploy/assess-bcs/eploy_candidate_in_pipeline_hub.png" />
</Frame>

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

## Move the candidate within the pipeline

To navigate to the *Pipeline* page, click on the `Go to Pipeline` option located under the `Work on Vacancy` dropdown menu on the vacancy page

<Frame>
  <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="navigate to pipeline page" src="https://mintcdn.com/stackone-hub/VECor-nT0Zr0Z2wh/images/eploy/assess-bcs/eploy_navigate_to_vacancy_pipeline.png?fit=max&auto=format&n=VECor-nT0Zr0Z2wh&q=85&s=d83c71456281c6bad59b670f76b9a604" width="902" height="189" data-path="images/eploy/assess-bcs/eploy_navigate_to_vacancy_pipeline.png" />
</Frame>

Move the candidate to the integration stage to initiate the background check invitation

<Frame>
  <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="move candidate" src="https://mintcdn.com/stackone-hub/VECor-nT0Zr0Z2wh/images/eploy/assess-bcs/eploy_bc_move_candidate_integration_stage.png?fit=max&auto=format&n=VECor-nT0Zr0Z2wh&q=85&s=399074b688f47d4ef29110cd8402d5cb" width="646" height="427" data-path="images/eploy/assess-bcs/eploy_bc_move_candidate_integration_stage.png" />
</Frame>

## To view the sent background check invitation

Navigate to the *Pipeline* page and click on the candidate to check the sent background check invitation

<Frame>
  <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="check the sent background check invitation" src="https://mintcdn.com/stackone-hub/VECor-nT0Zr0Z2wh/images/eploy/assess-bcs/eploy_bc_sent_to_the_candidate_as_visible_package_name_on_ui.png?fit=max&auto=format&n=VECor-nT0Zr0Z2wh&q=85&s=5a26153af23521ba48942407db5ccfb3" width="1186" height="443" data-path="images/eploy/assess-bcs/eploy_bc_sent_to_the_candidate_as_visible_package_name_on_ui.png" />
</Frame>

## To view the updated result of the background check

Go to the *Pipeline* page and click on the candidate to view the updated result of the background check

<Frame>
  <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="check the updated result of the background check" src="https://mintcdn.com/stackone-hub/VECor-nT0Zr0Z2wh/images/eploy/assess-bcs/eploy_bc_on_update_result_of_bc_on_ui.png?fit=max&auto=format&n=VECor-nT0Zr0Z2wh&q=85&s=7b728c599baa81fd16707f11d5e23b8e" width="1191" height="951" data-path="images/eploy/assess-bcs/eploy_bc_on_update_result_of_bc_on_ui.png" />
</Frame>

## Useful Links

<Card title="API Reference" icon="link" href="https://support.eploy.co.uk/hc/en-gb/articles/14089926025757-Eploy-RESTful-API-Workflow-based-Integrations">
  [https://support.eploy.co.uk/hc/en-gb/articles/14089926025757-Eploy-RESTful-API-Workflow-based-Integrations](https://support.eploy.co.uk/hc/en-gb/articles/14089926025757-Eploy-RESTful-API-Workflow-based-Integrations)
</Card>
