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

# Zinc

> How to set up the Zinc connector, plus the actions and events that are available.

![Zinc](https://stackone-logos.com/api/zinc/filled/svg)

v1.2.0[See changelog](https://docs.stackone.com/connectors/zinc/changelog.md)

[9 actions](#actions) · [9 events](#events) · 1 auth method

Background Checks

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/zinc/guides/connector-profile/api-key.md)
>
> Bearer token authentication using a Zinc Partner API key. Each key is bound to a single Zinc customer account, so all re...

Optionally, configure receiving Events for Zinc into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/zinc/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/zinc/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

9 actions

ActionDescription

Start Check (Pre-Configured Package)`zinc_start_check_with_package`

Start a background-check request against a pre-configured customer package.

Start Check (Custom Package Specification)`zinc_start_check_with_specification`

Start a background-check request with an inline package specification (no pre-configured package).

Cancel Request`zinc_cancel_request`

Cancel an in-flight background-check request.

Mark Request As Reviewed`zinc_mark_request_reviewed`

Move a request from action-required to reviewed.

Complete Manual DBS Identity Verification`zinc_complete_manual_dbs_identity_verification`

Mark the manual DBS identity verification action as complete on a background-check request.

List Packages`zinc_list_packages`

List the customer's pre-configured background-check packages.

Get Results`zinc_get_results`

Get the current status and results of a background-check request.

Get Report`zinc_get_report`

Download the PDF report for a completed background-check request.

Search Requests`zinc_search_requests`

Search background-check requests by candidate email(s) or by request ID.

## Events

Tags

Select all
|
Clear

Requests

Verification

Webhooks

No tags found

9 events

EventDescriptionTags

Active Check`zinc_active_check`

Acknowledges Zinc deliveries that carry no recognised statusV2 with a 200 response, so Zinc does not retry them.

VerificationWebhooks

Request Paused`zinc_webhook_request_paused`

Processes Zinc request updates with statusV2 paused, fired when the request is paused until it is resumed (coarse status...

RequestsWebhooks

Request Awaiting Candidate`zinc_webhook_request_awaiting_candidate`

Processes Zinc request updates with statusV2 awaiting-candidate, fired when the candidate must complete a step before ch...

RequestsWebhooks

Request Attention Needed`zinc_webhook_request_attention_needed`

Processes Zinc request updates with statusV2 attention-needed, fired when a recruiter action is required before checks c...

RequestsWebhooks

Request In Progress`zinc_webhook_request_in_progress`

Processes Zinc request updates with statusV2 in-progress, fired when the candidate or workflow is progressing checks and...

RequestsWebhooks

Request Ready for Review`zinc_webhook_request_ready_for_review`

Processes Zinc request updates with statusV2 ready-for-review, fired when the screening outcome is ready for the recruit...

RequestsWebhooks

Request All Clear`zinc_webhook_request_all_clear`

Processes Zinc request updates with statusV2 all-clear, fired when all checks completed with an overall clear outcome (c...

RequestsWebhooks

Request Reviewed`zinc_webhook_request_reviewed`

Processes Zinc request updates with statusV2 reviewed, fired when the recruiter has completed review of the outcome (coa...

RequestsWebhooks

Request Cancelled`zinc_webhook_request_cancelled`

Processes Zinc request updates with statusV2 cancelled, fired when the request is cancelled, through the Partner API or...

RequestsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.