# KarmaCheck Candidate onboarding API

**Canonical:** https://apis.io/apis/karmacheck/karmacheck-candidate-onboarding-api/  
**Provider:** KarmaCheck — https://apis.io/providers/karmacheck/  
**Base URL:** https://api.karmacheck.io  
**Documentation:** https://developer.karmacheck.com/background-check-api/overview/introduction

KarmaCheck Candidate onboarding API is one of 9 APIs that [KarmaCheck](https://apis.io/providers/karmacheck/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Candidate onboarding. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

The Candidate onboarding API from KarmaCheck — 20 operation(s) for candidate onboarding.

## Operations (26)

| Method | Path | Summary |
|---|---|---|
| POST | `/case/id/{caseId}/canadadisclosure/{language}` | Acknowledge Canada Disclosure |
| GET | `/case/id/{caseId}/canadadisclosure/{language}` | Get Canada Disclosure |
| POST | `/case/id/{caseId}/customdisclosure/{language}` | Acknowledge Custom Disclosure |
| GET | `/case/id/{caseId}/customdisclosure/{language}` | Get Custom Disclosure |
| POST | `/case/id/{caseId}/esig/{language}` | Acknowledge E-Signature |
| GET | `/case/id/{caseId}/esig/{language}` | Get E-Signature |
| POST | `/case/id/{caseId}/fcra/{language}` | Acknowledge FCRA |
| GET | `/case/id/{caseId}/fcra/{language}` | Get FCRA |
| POST | `/case/id/{caseId}/intldisclosure/{language}` | Acknowledge International Disclosure |
| GET | `/case/id/{caseId}/intldisclosure/{language}` | Get International Disclosure |
| PUT | `/case/id/{caseId}/{disclosureType}/{language}` | Acknowledge location-specific disclosures |
| POST | `/case/id/{caseId}/{disclosureType}/{language}` | Request location-specific disclosures |
| POST | `/invitation/candidate/create` | Create candidate by proxy for invitation |
| POST | `/testimony/create/case/id/{caseId}` | Create testimony for case |
| DELETE | `/testimony/id/{testimonyId}/detach/case/id/{caseId}` | Detach testimony from case |
| GET | `/candidate/invitation/token/{invitationToken}` | Get candidate for invitation |
| GET | `/candidate/countries` | Get countries |
| GET | `/invitation/case/{caseId}` | Get invitation for case ID |
| GET | `/case/id/{caseId}/legal/status/{legalType}` | Get legal acknowledgement status |
| GET | `/case/id/{caseId}/candidate/id/{candidateId}/url` | Get one-time token link |
| GET | `/candidate/secureimage/id/{secureImageId}` | Get secure image by ID |
| GET | `/testimony/case/{caseId}` | Get testimony for case |
| PUT | `/case/id/{caseId}/action/refreshinvite` | Refresh invitation for case |
| POST | `/case/id/{caseId}/action/resendinvite` | Resend case invitation |
| POST | `/candidate/id/{candidateId}/update/case/id/{caseId}` | Update candidate for case |
| POST | `/testimony/id/{testimonyId}/update/case/id/{caseId}` | Update testimony for case |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/karmacheck/refs/heads/main/openapi/karmacheck-candidate-onboarding-api-openapi.yml
- **Documentation** — https://developer.karmacheck.com/background-check-api/overview/introduction
- **APIReference** — https://developer.karmacheck.com/api-reference/authentication/authenticate-api-client

## Other KarmaCheck APIs (8)

- [KarmaCheck Authentication API](https://apis.io/apis/karmacheck/karmacheck-authentication-api/)
- [KarmaCheck Case API](https://apis.io/apis/karmacheck/karmacheck-case-api/)
- [KarmaCheck Cases API](https://apis.io/apis/karmacheck/karmacheck-cases-api/)
- [KarmaCheck Packages API](https://apis.io/apis/karmacheck/karmacheck-packages-api/)
- [KarmaCheck Secure documents API](https://apis.io/apis/karmacheck/karmacheck-secure-documents-api/)
- [KarmaCheck Services API](https://apis.io/apis/karmacheck/karmacheck-services-api/)
- [KarmaCheck Users API](https://apis.io/apis/karmacheck/karmacheck-users-api/)
- [KarmaCheck Verification Book API](https://apis.io/apis/karmacheck/karmacheck-verification-book-api/)

## Tags

Candidate onboarding

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/karmacheck/karmacheck-candidate-onboarding-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/karmacheck/.