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

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

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

[22 actions](#actions) · [2 events](#events) · 1 auth method

Background Checks
IAM

## 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/veremark/guides/connector-profile/api-key.md)
>
> API tokens are provided by Veremark and cannot be self-generated. Contact your Veremark Account Manager to request sandb...

Optionally, configure receiving Events for Veremark into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/veremark/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/veremark/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

22 actions

ActionDescription

List Candidates`veremark_list_candidates`

Retrieve a list of all candidates in your Veremark account.

Delete Candidate`veremark_delete_candidate`

Soft delete a specific candidate from your Veremark account by their GUID.

List Checks`veremark_list_checks`

Retrieve a list of all available background checks, optionally filtered by country.

List Criteria`veremark_list_criteria`

Retrieve a list of all background check criteria templates in your Veremark account.

Get Criteria`veremark_get_criteria`

Retrieve details of a specific criteria template by its GUID.

Create Criteria`veremark_create_criteria`

Create a new background check criteria template with specified checks and country.

Delete Criteria`veremark_delete_criteria`

Delete a specific criteria template by its GUID.

Upload Document`veremark_upload_document`

Upload a document to Veremark as multipart/form-data for use in background check verification.

Get Document`veremark_get_document`

Download the binary content of a specific document by its GUID.

List Requests`veremark_list_requests`

Retrieve a list of all background check requests, optionally filtered by status change date.

Get Request`veremark_get_request`

Retrieve details of a specific background check request by its GUID.

Create Request`veremark_create_request`

Create a new background check request for a candidate using specified criteria.

Delete Request`veremark_delete_request`

Delete a background check request by its GUID. Only requests in expired, requested, or draft status can be deleted.

Update Check Status`veremark_update_check_status`

Update the status of a specific check within a background check request.

Create Magic Links`veremark_create_magic_links`

Create time-limited magic links for accessing the report of a specific background check request.

Force Check Status`veremark_force_check_status`

Force a specific check status transition within a background check request using the restricted endpoint. Requires eleva...

Get Full Report`veremark_get_full_report`

Download the full PDF report for a background check request.

Get Check Report`veremark_get_check_report`

Download the PDF report for a specific individual check within a background check request.

List Users`veremark_list_users`

Retrieve a list of all external users in your Veremark account.

Get User`veremark_get_user`

Retrieve details of a specific user in your Veremark account by their GUID.

Create User`veremark_create_user`

Create a new user in your Veremark account with a specified role.

Delete User`veremark_delete_user`

Delete a specific user from your Veremark account by their GUID.

## Events

Tags

Select all
|
Clear

Requests

Webhooks

No tags found

2 events

EventDescriptionTags

Webhook Active Check`veremark_webhook_active_check`

Acknowledges delivery probes and any request that is not a Veremark request status notification, without emitting an eve...

Webhooks

Request Status Changed`veremark_webhook_request_status_changed`

Fired when a background check request created with this account's Native Webhook URL, or one of its checks, changes stat...

RequestsWebhooks


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