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.
The KarmaCheck API supports two environments: staging and production. You can use the staging environment as a sandbox to test all available KarmaCheck functionality without affecting your live data. To access a KarmaCheck environment, contact your KarmaCheck account manager to obtain your API credentials.
URLs
| Environment | API base URL | KarmaCheck dashboard URL |
|---|
| Staging | https://api-stage.karmacheck.io | https://app-stage.karmacheck.com |
| Production | https://api.karmacheck.io | https://app.karmacheck.com |
Testing considerations
The KarmaCheck sandbox and production environments provide simulated data for testing your integrations and service flows. Note the following scenarios and limitations when testing in these environments.
Sandbox limitations
When testing in the sandbox, all email notifications to candidates, such as invitations for candidates to initiate onboarding, are blocked from being sent to external email addresses. Instead, these emails are directed to a shared internal email inbox. If you’d like to receive copies of these emails, contact us to set up email forwarding.
Predefined SSNs
KarmaCheck supports usage of the following Social Security numbers (SSNs) to return either clean or unfavorable service results on the candidate:
- 111-22-3333: Use this SSN for certain services to be returned as cleared.
- 333-22-1111: Use this SSN for certain services to be returned with results or records that require review.
See the next section for a list of applicable services.
Simulated services
KarmaCheck simulates results for a number of services after completion of candidate onboarding or PII entry during case ordering. These simulations lead to a case data completion status (in other words, the service is clear or needs review) for each service. All KarmaCheck environments generate simulated results for the following services, listed by service category:
Identity verification
| Service | Status | Test data required |
|---|
| SSN Trace | clear | SSN: 111-22-3333 |
| International Identity Verification | acknowledge | Any data |
Criminal check
| Service | Status | Test data required |
|---|
| OIG Exclusions Search | clear | Any data |
| National Criminal Search | clear | SSN: 111-22-3333 |
| Global Watchlist Search | clear | SSN: 111-22-3333 |
| Sex Offender Search | clear | SSN: 111-22-3333 |
| International Criminal Record Check | clear | Name: Andrew McLeod; Date of birth: March 4, 1987 |
| International Criminal Record Check | consider | Name: Andrew McLeod; Date of birth: any date other than March 4, 1987 |
| Canadian Criminal Record Check | clear | Any data, except the name Will Nettke |
| Canadian Criminal Record Check | consider | Name: Will Nettke |
Motor vehicle record check
| Service | Status | Test data required |
|---|
| Motor Vehicle Report | acknowledge | SSN: 111-22-3333 |
| Canadian Motor Vehicle Record Check | clear | Any data, except driver’s licenses issued in British Columbia |
| Canadian Motor Vehicle Record Check | consider | Driver’s license issued in British Columbia |
Occupational health screening
| Service | Status | Test data required |
|---|
Any physical screening (except Lab - CBC With Differential; Audiogram Annual/Baseline supports acknowledge only) | acknowledge | SSN: 111-22-3333 |
Any physical screening (except Lab - CBC With Differential; Audiogram Annual/Baseline supports acknowledge only) | consider | SSN: 333-22-1111 |
| Any drug screening | clear | SSN: 111-22-3333 |
| Any drug screening | consider | SSN: 333-22-1111 |
| Any TB test | acknowledge | SSN: 111-22-3333 |
| Any TB test | consider | SSN: 333-22-1111 |
| Any immunization (except Hepatitis B Surface Antigen Titer; Hepatitis C Titer) | acknowledge | SSN: 111-22-3333 |
| Any immunization (except Hepatitis B Surface Antigen Titer; Hepatitis C Titer) | consider | SSN: 333-22-1111 |
| Hepatitis C Titer | acknowledge | SSN: 333-22-1111 |
| Hepatitis C Titer | consider | SSN: 111-22-3333 |
Professional license and certification
| Service | Status | Test data required |
|---|
| CNM (APRN) Verification | consider | Any fictitious license |
| CNP (APRN) Verification | consider | Any fictitious license |
| CNS (APRN) Verification | consider | Any fictitious license |
| CRNA (APRN) Verification | consider | Any fictitious license |
| PN Verification | consider | Any fictitious license |
| RN Verification | consider | Any fictitious license |
All other screenings remain in a pending status.
