KarmaCheck provides an API-first platform for ordering and tracking background checks, credential verifications, and occupational health screenings. With the KarmaCheck API, you can: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.
- Submit orders that consist of various screenings, ranging from one to many.
- Track the state of an order throughout its lifecycle.
- Review the overall results of a background check, as well as the details of individual screenings.
- Adjudicate a completed background check.
- Receive data asynchronously through the webhook infrastructure.
Who is the API for?
The KarmaCheck API enables businesses to seamlessly integrate background checks into their applications and services. Whether you’re building your own integrations or extending offerings to your customers, KarmaCheck makes it easy to order and manage a range of services.- For customers: Use the KarmaCheck API to integrate and automate your background check processes. Accessing the API simply requires obtaining your API credentials from your KarmaCheck account manager.
- For partners: Enhance your applicant tracking system (ATS), customer relationship management (CRM), or any recruitment platform by integrating with KarmaCheck’s background check capabilities. To access the API, reach out to an account manager to register as a KarmaCheck partner, and have our mutual customers request API access on your behalf.
Common integration scenarios
The workflows for ordering KarmaCheck services and onboarding candidates are flexible and customizable. The following table describes the different ways you can order and initiate a background check on a candidate.| Integration scenario | Description | Try out the workflow |
|---|---|---|
| Candidate-provided PII flow | Invite the candidate to participate in the KarmaCheck-hosted candidate onboarding process. The candidate will receive an invitation email from KarmaCheck to access a KarmaCheck candidate dashboard, where they can enter their personally identifiable information (PII) and authorize the check. The background check is initiated after the candidate completes this process. | See Candidate-provided PII flow for details on how to order a background check. |
| Customer-provided PII flow | Initiate a background check by providing the candidate’s PII and other required data during check ordering. This requires confirmation that you gathered consent from the candidate to begin running a background check. | See Customer-provided PII flow for details on how to order and initiate a background check. |
| Custom candidate onboarding | Build your own candidate onboarding experience instead of using the KarmaCheck-hosted candidate onboarding process. | Contact KarmaCheck Customer Success for guidance on this type of integration. |