Skip to main content
Zinc
9 actions · 9 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.
2

Configure the Connector

Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.

API Key · Connector Profile

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.

Webhooks setup

3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

API Key · Link Account

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

9 actions
Action
Description
Start Check (Pre-Configured Package)
Start a background-check request against a pre-configured customer package.
Start Check (Custom Package Specification)
Start a background-check request with an inline package specification (no pre-configured package).
Cancel Request
Cancel an in-flight background-check request.
Mark Request As Reviewed
Move a request from action-required to reviewed.
Complete Manual DBS Identity Verification
Mark the manual DBS identity verification action as complete on a background-check request.
List Packages
List the customer’s pre-configured background-check packages.
Get Results
Get the current status and results of a background-check request.
Get Report
Download the PDF report for a completed background-check request.
Search Requests
Search background-check requests by candidate email(s) or by request ID.

Events

|
9 events
Event
Description
Tags
Active Check
Acknowledges Zinc deliveries that carry no recognised statusV2 with a 200 response, so Zinc does not retry them.
VerificationWebhooks
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
Processes Zinc request updates with statusV2 awaiting-candidate, fired when the candidate must complete a step before ch…
RequestsWebhooks
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
Processes Zinc request updates with statusV2 in-progress, fired when the candidate or workflow is progressing checks and…
RequestsWebhooks
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
Processes Zinc request updates with statusV2 all-clear, fired when all checks completed with an overall clear outcome (c…
RequestsWebhooks
Request Reviewed
Processes Zinc request updates with statusV2 reviewed, fired when the recruiter has completed review of the outcome (coa…
RequestsWebhooks
Request Cancelled
Processes Zinc request updates with statusV2 cancelled, fired when the request is cancelled, through the Partner API or…
RequestsWebhooks