> ## 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 that are available.

<div className="connector-page-header">
  <img src="https://stackone-logos.com/api/zinc/filled/svg" alt="Zinc" className="connector-page-icon" />

  <div className="connector-page-changelog">
    <div className="connector-page-version"><span>v1.1.0</span></div>
    <div><a href="/connectors/zinc/changelog">See changelog</a></div>
  </div>

  <div className="connector-page-header-meta">
    <div className="connector-page-subtitle"><a href="#actions">9 actions</a> · 1 auth method</div>

    <div className="connector-page-category-tags">
      <span className="connector-page-category-tag">Background Checks</span>
    </div>
  </div>
</div>

## Getting Started

<Steps>
  <Step title="Create or Select a Project">
    Set up a new project or select an existing one. See [Organizations & Projects](/gateway/concepts/organizations-and-projects).
  </Step>

  <Step title="Configure the Connector">
    Enable the connector and set up a Connector Profile in your project. See [Setup Connector Profile](/gateway/quickstart#setup-connector-profile).

    <Columns cols={2}>
      <Card title="Connector Profile · API Key" href="/connectors/zinc/guides/connector-profile/api-key" icon="https://stackone-logos.com/api/zinc/filled/svg" horizontal>
        Bearer token authentication using a Zinc Partner API key. Each key is bound to a single Zinc customer account, so all re...
      </Card>
    </Columns>
  </Step>

  <Step title="Link an Account">
    Link an account [from the dashboard](/connect/managing-connectors/linking-accounts#link-from-the-dashboard) (or via [StackOne Hub](/embed/account-linking/overview)).

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

    <Columns cols={2}>
      <Card title="Link Account · API Key" href="/connectors/zinc/guides/link-account/api-key" icon="https://stackone-logos.com/api/zinc/filled/svg" horizontal />
    </Columns>
  </Step>

  <Step title="Use Actions">
    Connect an AI platform to the linked account's actions. See [AI Platforms](/connect/ai-platforms/overview).

    Other ways to call actions are listed in [Protocols & SDKs](/connect/protocols-and-sdks).
  </Step>
</Steps>

## Actions

<div className="connector-meta-library-section">
  <div className="connector-actions-controls not-prose" data-connector-actions-controls>
    <div className="connector-actions-controls__row">
      <input type="search" className="connector-actions-search" data-connector-actions-search placeholder="Search actions" aria-label="Search actions" />
    </div>
  </div>

  <div className="meta-library-count" data-connector-actions-count>9 actions</div>

  <div className="not-prose meta-library-table-container" data-connector-actions-table>
    <div className="connector-meta-library-grid">
      <div className="connector-meta-library-row">
        <div className="meta-library-grid-header-cell">Action</div>
        <div className="meta-library-grid-header-cell">Description</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="zinc_start_check_with_package" data-action-label="Start Check (Pre-Configured Package)" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Start Check (Pre-Configured Package)</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="zinc_start_check_with_package" aria-label="Copy zinc_start_check_with_package"><code className="connector-page-code">zinc\_start\_check\_with\_package</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Start a background-check request against a pre-configured customer package.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="zinc_start_check_with_specification" data-action-label="Start Check (Custom Package Specification)" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Start Check (Custom Package Specification)</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="zinc_start_check_with_specification" aria-label="Copy zinc_start_check_with_specification"><code className="connector-page-code">zinc\_start\_check\_with\_specification</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Start a background-check request with an inline package specification (no pre-configured package).</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="zinc_cancel_request" data-action-label="Cancel Request" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Cancel Request</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="zinc_cancel_request" aria-label="Copy zinc_cancel_request"><code className="connector-page-code">zinc\_cancel\_request</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Cancel an in-flight background-check request.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="zinc_mark_request_reviewed" data-action-label="Mark Request As Reviewed" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Mark Request As Reviewed</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="zinc_mark_request_reviewed" aria-label="Copy zinc_mark_request_reviewed"><code className="connector-page-code">zinc\_mark\_request\_reviewed</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Move a request from action-required to reviewed.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="zinc_complete_manual_dbs_identity_verification" data-action-label="Complete Manual DBS Identity Verification" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Complete Manual DBS Identity Verification</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="zinc_complete_manual_dbs_identity_verification" aria-label="Copy zinc_complete_manual_dbs_identity_verification"><code className="connector-page-code">zinc\_complete\_manual\_dbs\_identity\_verification</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Mark the manual DBS identity verification action as complete on a background-check request.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="zinc_list_packages" data-action-label="List Packages" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Packages</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="zinc_list_packages" aria-label="Copy zinc_list_packages"><code className="connector-page-code">zinc\_list\_packages</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List the customer's pre-configured background-check packages.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="zinc_get_results" data-action-label="Get Results" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Results</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="zinc_get_results" aria-label="Copy zinc_get_results"><code className="connector-page-code">zinc\_get\_results</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get the current status and results of a background-check request.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="zinc_get_report" data-action-label="Get Report" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Report</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="zinc_get_report" aria-label="Copy zinc_get_report"><code className="connector-page-code">zinc\_get\_report</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Download the PDF report for a completed background-check request.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="zinc_search_requests" data-action-label="Search Requests" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Search Requests</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="zinc_search_requests" aria-label="Copy zinc_search_requests"><code className="connector-page-code">zinc\_search\_requests</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Search background-check requests by candidate email(s) or by request ID.</div>
      </div>
    </div>
  </div>
</div>


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