KarmaCheck

KarmaCheck Candidate onboarding API

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

GitHub OpenAPI
Business capability
Talent Acquisition Management BC-300.10

Operations 26

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}/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 #

Documentation

📖
Documentation
https://developer.karmacheck.com/background-check-api/overview/introduction
📖
APIReference
https://developer.karmacheck.com/api-reference/authentication/authenticate-api-client

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/karmacheck/refs/heads/main/openapi/karmacheck-candidate-onboarding-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/karmacheck-candidate-onboarding-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

karmacheck-candidate-onboarding-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: KarmaCheck Candidate onboarding API
  description: 'All requests to the KarmaCheck API require a JSON Web Token (JWT) in the Authorization header. For an overview of the API and its authentication method, refer to the following topics:


    - API basics

    - Authentication

    - Environments

    - Status codes and errors'
  version: '1.0'
  contact:
    name: KarmaCheck
    email: customersuccess@karmacheck.com
servers:
- description: Stage
  url: https://api-stage.karmacheck.io
- description: Prod
  url: https://api.karmacheck.io
security:
- JWT: []
tags:


# --- truncated at 32 KB (173 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/karmacheck/refs/heads/main/openapi/karmacheck-candidate-onboarding-api-openapi.yml