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.

This page defines terms that are used throughout the KarmaCheck developer documentation. These terms are ordered so that each definition builds on a previous one.

​
Candidate

An individual who is the target of a background check.

​
Service

An individual service that’s performed on a candidate as part of a larger background check. KarmaCheck supports multiple types of services, many of which are referred to as screenings.

​
Package

A group of services to execute on a candidate for a complete background check.

​
Case

An ordered background check. A case is an active instance of a package, and links a candidate to the package. When a case is complete, a report will be made available for that case.

​
Case data

The information for a specific service of an ordered case. Case data will exist for each service of the ordered case.

​
Order data

The information supplied at the time of ordering a background check or adding additional services after the background check was ordered.

​
Onboarding

The process that a candidate goes through to approve the running of a case and provide any necessary personally identifiable information (PII). The KarmaCheck onboarding process collects the information required to execute the services of the ordered case, presents the candidate with the appropriate disclosures, and gathers all necessary approvals and signatures to allow the execution of the case to move forward.

​
Invitation

Token-based access for a candidate to initiate the onboarding process of an ordered background check.

​
Company

A KarmaCheck customer that’s ordering background checks.

​
Group

A virtual division within a company for grouping access to candidates, available packages, and running checks. This division is used to control access among multiple users of the company as well as to organize the company’s accounting by group.

​
Customer

  1. A KarmaCheck customer that uses the KarmaCheck API to order background checks for their own company. Such customers are a primary audience for the KarmaCheck developer documentation.
  2. A KarmaCheck customer that uses their own KarmaCheck account to log in to the KarmaCheck dashboard to order background checks.
  3. A KarmaCheck customer that enables a partner to use the KarmaCheck API to order background checks on their behalf.

​
Partner

A KarmaCheck partner enabled by a mutual customer to order background checks on the company’s behalf. A partner must register with KarmaCheck and obtain one or more client access tokens from the mutual customer.

​
API key

A unique key that enables programmatic access to KarmaCheck. An API key is issued in two scenarios:
  • For a customer who is building an integration with their own system for their own access.
  • For a vendor who is building a solution for their customers. This vendor is referred to as a partner.

​
Client access token

A unique token provided to a customer, enabling them to programmatically access and manage cases for a specific group in their company. The customer can also provide the token to an API partner if they want that partner to access their cases on their behalf.