Skip to main content
Veremark
v1.0.0
22 actions · 1 auth method

​
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 set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · API Key

API tokens are provided by Veremark and cannot be self-generated. Contact your Veremark Account Manager to request sandb…
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:

Link Account · API Key

4

Use Actions

Connect your agent to the linked account’s actions. See Agent Setup.Other ways to call actions are listed in Protocols & SDKs.

​
Actions

22 actions
Action
Description
List Candidates
Retrieve a list of all candidates in your Veremark account.
Delete Candidate
Soft delete a specific candidate from your Veremark account by their GUID.
List Checks
Retrieve a list of all available background checks, optionally filtered by country.
List Criteria
Retrieve a list of all background check criteria templates in your Veremark account.
Get Criteria
Retrieve details of a specific criteria template by its GUID.
Create Criteria
Create a new background check criteria template with specified checks and country.
Delete Criteria
Delete a specific criteria template by its GUID.
Upload Document
Upload a document to Veremark as multipart/form-data for use in background check verification.
Get Document
Download the binary content of a specific document by its GUID.
List Requests
Retrieve a list of all background check requests, optionally filtered by status change date.
Get Request
Retrieve details of a specific background check request by its GUID.
Create Request
Create a new background check request for a candidate using specified criteria.
Delete Request
Delete a background check request by its GUID. Only requests in expired, requested, or draft status can be deleted.
Update Check Status
Update the status of a specific check within a background check request.
Create Magic Links
Create time-limited magic links for accessing the report of a specific background check request.
Force Check Status
Force a specific check status transition within a background check request using the restricted endpoint. Requires eleva…
Get Full Report
Download the full PDF report for a background check request.
Get Check Report
Download the PDF report for a specific individual check within a background check request.
List Users
Retrieve a list of all external users in your Veremark account.
Get User
Retrieve details of a specific user in your Veremark account by their GUID.
Create User
Create a new user in your Veremark account with a specified role.
Delete User
Delete a specific user from your Veremark account by their GUID.