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

# Veremark

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

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

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

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

    <div className="connector-page-category-tags">
      <span className="connector-page-category-tag">Background Checks</span>
      <span className="connector-page-category-tag">IAM</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/veremark/guides/connector-profile/api-key" icon="https://stackone-logos.com/api/veremark/filled/svg" horizontal>
        API tokens are provided by Veremark and cannot be self-generated. Contact your Veremark Account Manager to request sandb...
      </Card>
    </Columns>

    Optionally, configure receiving Events for Veremark into StackOne.

    <Columns cols={2}>
      <Card title="Webhooks setup" href="/connectors/veremark/guides/webhook-setup" icon="webhook" horizontal />
    </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/veremark/guides/link-account/api-key" icon="https://stackone-logos.com/api/veremark/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>22 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="veremark_list_candidates" data-action-label="List Candidates" 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 Candidates</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="veremark_list_candidates" aria-label="Copy veremark_list_candidates"><code className="connector-page-code">veremark\_list\_candidates</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a list of all candidates in your Veremark account.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="veremark_delete_candidate" data-action-label="Delete Candidate" 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>Delete Candidate</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="veremark_delete_candidate" aria-label="Copy veremark_delete_candidate"><code className="connector-page-code">veremark\_delete\_candidate</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Soft delete a specific candidate from your Veremark account by their GUID.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="veremark_list_checks" data-action-label="List Checks" 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 Checks</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="veremark_list_checks" aria-label="Copy veremark_list_checks"><code className="connector-page-code">veremark\_list\_checks</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a list of all available background checks, optionally filtered by country.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="veremark_list_criteria" data-action-label="List Criteria" 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 Criteria</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="veremark_list_criteria" aria-label="Copy veremark_list_criteria"><code className="connector-page-code">veremark\_list\_criteria</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a list of all background check criteria templates in your Veremark account.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="veremark_get_criteria" data-action-label="Get Criteria" 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 Criteria</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="veremark_get_criteria" aria-label="Copy veremark_get_criteria"><code className="connector-page-code">veremark\_get\_criteria</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve details of a specific criteria template by its GUID.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="veremark_create_criteria" data-action-label="Create Criteria" 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>Create Criteria</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="veremark_create_criteria" aria-label="Copy veremark_create_criteria"><code className="connector-page-code">veremark\_create\_criteria</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Create a new background check criteria template with specified checks and country.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="veremark_delete_criteria" data-action-label="Delete Criteria" 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>Delete Criteria</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="veremark_delete_criteria" aria-label="Copy veremark_delete_criteria"><code className="connector-page-code">veremark\_delete\_criteria</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Delete a specific criteria template by its GUID.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="veremark_upload_document" data-action-label="Upload Document" 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>Upload Document</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="veremark_upload_document" aria-label="Copy veremark_upload_document"><code className="connector-page-code">veremark\_upload\_document</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Upload a document to Veremark as multipart/form-data for use in background check verification.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="veremark_get_document" data-action-label="Get Document" 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 Document</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="veremark_get_document" aria-label="Copy veremark_get_document"><code className="connector-page-code">veremark\_get\_document</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Download the binary content of a specific document by its GUID.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="veremark_list_requests" data-action-label="List 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>List Requests</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="veremark_list_requests" aria-label="Copy veremark_list_requests"><code className="connector-page-code">veremark\_list\_requests</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a list of all background check requests, optionally filtered by status change date.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="veremark_get_request" data-action-label="Get 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>Get Request</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="veremark_get_request" aria-label="Copy veremark_get_request"><code className="connector-page-code">veremark\_get\_request</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve details of a specific background check request by its GUID.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="veremark_create_request" data-action-label="Create 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>Create Request</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="veremark_create_request" aria-label="Copy veremark_create_request"><code className="connector-page-code">veremark\_create\_request</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Create a new background check request for a candidate using specified criteria.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="veremark_delete_request" data-action-label="Delete 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>Delete Request</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="veremark_delete_request" aria-label="Copy veremark_delete_request"><code className="connector-page-code">veremark\_delete\_request</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Delete a background check request by its GUID. Only requests in expired, requested, or draft status can be deleted.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="veremark_update_check_status" data-action-label="Update Check Status" 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>Update Check Status</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="veremark_update_check_status" aria-label="Copy veremark_update_check_status"><code className="connector-page-code">veremark\_update\_check\_status</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Update the status of a specific check within a background check request.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="veremark_create_magic_links" data-action-label="Create Magic Links" 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>Create Magic Links</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="veremark_create_magic_links" aria-label="Copy veremark_create_magic_links"><code className="connector-page-code">veremark\_create\_magic\_links</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Create time-limited magic links for accessing the report of a specific background check request.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="veremark_force_check_status" data-action-label="Force Check Status" 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>Force Check Status</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="veremark_force_check_status" aria-label="Copy veremark_force_check_status"><code className="connector-page-code">veremark\_force\_check\_status</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Force a specific check status transition within a background check request using the restricted endpoint. Requires eleva...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="veremark_get_full_report" data-action-label="Get Full 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 Full Report</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="veremark_get_full_report" aria-label="Copy veremark_get_full_report"><code className="connector-page-code">veremark\_get\_full\_report</code></button></div>
        </div>

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

      <div className="connector-meta-library-row" data-action-id="veremark_get_check_report" data-action-label="Get Check 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 Check Report</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="veremark_get_check_report" aria-label="Copy veremark_get_check_report"><code className="connector-page-code">veremark\_get\_check\_report</code></button></div>
        </div>

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

      <div className="connector-meta-library-row" data-action-id="veremark_list_users" data-action-label="List Users" 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 Users</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="veremark_list_users" aria-label="Copy veremark_list_users"><code className="connector-page-code">veremark\_list\_users</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a list of all external users in your Veremark account.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="veremark_get_user" data-action-label="Get User" 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 User</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="veremark_get_user" aria-label="Copy veremark_get_user"><code className="connector-page-code">veremark\_get\_user</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve details of a specific user in your Veremark account by their GUID.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="veremark_create_user" data-action-label="Create User" 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>Create User</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="veremark_create_user" aria-label="Copy veremark_create_user"><code className="connector-page-code">veremark\_create\_user</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Create a new user in your Veremark account with a specified role.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="veremark_delete_user" data-action-label="Delete User" 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>Delete User</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="veremark_delete_user" aria-label="Copy veremark_delete_user"><code className="connector-page-code">veremark\_delete\_user</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Delete a specific user from your Veremark account by their GUID.</div>
      </div>
    </div>
  </div>
</div>

## Events

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

      <div className="connector-actions-scopes" data-connector-events-scopes>
        <button type="button" className="connector-actions-scopes__toggle" data-connector-events-scopes-toggle aria-expanded="false">
          <span>Tags<span data-connector-events-scopes-count /></span>
        </button>

        <div className="connector-actions-scopes__menu">
          <div className="connector-actions-scopes__header">
            <input type="search" className="connector-actions-scopes__search" data-connector-events-scope-search placeholder="Search tags..." aria-label="Search tags" />

            <div className="connector-actions-scopes__actions">
              <button type="button" data-connector-events-scopes-select-all>Select all</button>
              <span>|</span>
              <button type="button" data-connector-events-scopes-clear>Clear</button>
            </div>
          </div>

          <label className="connector-actions-scopes__item">
            <input type="checkbox" value="Requests" data-connector-events-scope-filter />

            <span>Requests</span>
          </label>

          <label className="connector-actions-scopes__item">
            <input type="checkbox" value="Webhooks" data-connector-events-scope-filter />

            <span>Webhooks</span>
          </label>

          <div className="connector-actions-scopes__empty" data-connector-events-scopes-empty hidden>No tags found</div>
        </div>
      </div>
    </div>
  </div>

  <div className="meta-library-count" data-connector-events-count>2 events</div>

  <div className="not-prose meta-library-table-container" data-connector-events-table>
    <div className="connector-meta-library-grid connector-meta-library-grid--three-col">
      <div className="connector-meta-library-row">
        <div className="meta-library-grid-header-cell">Event</div>
        <div className="meta-library-grid-header-cell">Description</div>
        <div className="meta-library-grid-header-cell">Tags</div>
      </div>

      <div className="connector-meta-library-row" data-event-id="veremark_webhook_active_check" data-event-label="Webhook Active Check" data-event-tags="Webhooks">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Webhook Active Check</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="veremark_webhook_active_check" aria-label="Copy veremark_webhook_active_check"><code className="connector-page-code">veremark\_webhook\_active\_check</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Acknowledges delivery probes and any request that is not a Veremark request status notification, without emitting an eve...</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><span className="connector-page-category-tag">Webhooks</span></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-event-id="veremark_webhook_request_status_changed" data-event-label="Request Status Changed" data-event-tags="Requests,Webhooks">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Request Status Changed</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="veremark_webhook_request_status_changed" aria-label="Copy veremark_webhook_request_status_changed"><code className="connector-page-code">veremark\_webhook\_request\_status\_changed</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Fired when a background check request created with this account's Native Webhook URL, or one of its checks, changes stat...</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><span className="connector-page-category-tag">Requests</span><span className="connector-page-category-tag">Webhooks</span></div>
        </div>
      </div>
    </div>
  </div>
</div>


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