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.

API partners can access the KarmaCheck system on behalf of mutual customers, allowing them to order and receive the results of background checks. Enabling integration with KarmaCheck as an API partner requires two steps:

​
Step 1: Partner registration

Register with KarmaCheck Customer Success as an API partner:
  1. Request an API key from KarmaCheck that allows you to gain access to the KarmaCheck system.
  2. Request a client access token for a sandbox demo company on the KarmaCheck sandbox server.
  3. (Optional) Supply KarmaCheck with a URL where you want to receive webhook event calls. See Subscriptions for details about configuring webhooks.

​
Step 2: Customer access

When a mutual customer wants to access the KarmaCheck system through the partnership, they will:
  1. Request a client access token for each of their company groups from KarmaCheck.
  2. Provide you with one or more client access tokens.
The combination of your API key and the customer-provided client access token enables you to authenticate in the KarmaCheck system and perform API calls on behalf of the specific client company and group associated with the client access token.