Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.karmacheck.com/llms.txt

Use this file to discover all available pages before exploring further.

As a KarmaCheck customer, you have access to the KarmaCheck API and the user dashboard. Integrating with the API gives you the ability to programmatically order background checks and receive results of those background checks.

​
Enable API access

To gain access to the KarmaCheck API, contact KarmaCheck Customer Success to request the following:
  1. An API key that allows your company to access the KarmaCheck system
  2. A client access token that gives access to a specific group in your company
The combination of the API key and the client access token enables you to authenticate with the KarmaCheck system in a specific environment (either sandbox or production) and perform API calls for the group that’s associated with the client access token. If you have multiple groups within KarmaCheck, you’ll need a client access token for each group.

​
Optional: Set up webhooks

You have the option to set up webhooks if you want to receive status updates on ordered background checks. To receive webhook event calls, provide KarmaCheck with the URL where you want to receive webhook event notifications. See Subscriptions for details about configuring webhooks.