Skip to main content
API tokens must be requested from your Veremark Account Manager. Self-service generation is not available.

​
Getting Started with Veremark API

Veremark provides API tokens directly to customers. Tokens cannot be self-generated through a portal.

1

Request Sandbox Access

Contact your Veremark Account Manager to set up a sandbox (testing) account.

  • Veremark will configure the necessary user profiles for your testing account.
  • An API token for the sandbox environment will be provided via email to your designated contact.
  • Access the API documentation for integration details.
2

Configure Criteria

Work with your Account Manager to set up Criteria (packages of background checks) tailored to your needs.

  • Criteria represent configurable packages of background checks used when requesting checks via the API.
  • Your Account Manager can help define and configure criteria for your specific requirements.
3

Request Production Token

After testing your integration in the sandbox environment, request a production API token.

  • The production API token is different from your sandbox token.
  • The production token will be sent to your nominated contact.
  • Store the token securely and enter it below to authenticate API requests.

​
Linking the Account from the Hub

1

Navigate to the Hub

Use one of the three Linking Account Methods to access the Hub.
2

Fill out the fields

Fill out the following fields using details from your provider:
  • API Token
3

Connect

  • Click Connect
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup

If the account linking is successful, you will see the newly linked account in your Accounts page.